// Copyright (c) Dolittle. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

/**
 * Defines something that is equatable to other things.
 */
export interface IEquatable {
    /**
     * Check whether this instance is equal to another instance.
     * @param {any} other - The instance to compare to.
     * @returns {boolean} True if the instances are equal, false if not.
     */
    equals(other: any): boolean
}

/**
 * Checks whether or not an object is an instance of {@link IEquatable}.
 * @param {any} object - The object to check.
 * @returns {boolean} True if the object is an {@link IEquatable}, false if not.
 */
export const isEquatable = (object: any): object is IEquatable => {
    if (typeof object !== 'object' || object === null) return false;
    if (typeof object.equals !== 'function' || object.equals.length !== 1) return false;
    return true;
};