fast-equals

method delete

delete: (key: Key) => boolean;

method get

get: (key: Key) => Value | undefined;

method set

set: (key: Key, value: any) => any;

property areArrayBuffersEqual

areArrayBuffersEqual: EqualityComparator<Meta>;

• Whether the array buffers passed are equal in value. In strict mode, this includes additional properties added to the array.

property areArraysEqual

areArraysEqual: EqualityComparator<Meta>;

• Whether the arrays passed are equal in value. In strict mode, this includes additional properties added to the array.

property areDataViewsEqual

areDataViewsEqual: EqualityComparator<Meta>;

• Whether the data views passed are equal in value.

property areDatesEqual

areDatesEqual: EqualityComparator<Meta>;

• Whether the dates passed are equal in value.

property areErrorsEqual

areErrorsEqual: EqualityComparator<Meta>;

• Whether the errors passed are equal in value.

property areFunctionsEqual

areFunctionsEqual: EqualityComparator<Meta>;

• Whether the functions passed are equal in value.

property areMapsEqual

areMapsEqual: EqualityComparator<Meta>;

• Whether the maps passed are equal in value. In strict mode, this includes additional properties added to the map.

property areNumbersEqual

areNumbersEqual: EqualityComparator<Meta>;

• Whether the numbers passed are equal in value.

property areObjectsEqual

areObjectsEqual: EqualityComparator<Meta>;

• Whether the objects passed are equal in value. In strict mode, this includes non-enumerable properties added to the map, as well as symbol properties.

property arePrimitiveWrappersEqual

arePrimitiveWrappersEqual: EqualityComparator<Meta>;

• Whether the primitive wrappers passed are equal in value.

property areRegExpsEqual

areRegExpsEqual: EqualityComparator<Meta>;

• Whether the regexps passed are equal in value.

property areSetsEqual

areSetsEqual: EqualityComparator<Meta>;

• Whether the sets passed are equal in value. In strict mode, this includes additional properties added to the set.

property areTypedArraysEqual

areTypedArraysEqual: EqualityComparator<Meta>;

• Whether the typed arrays passed are equal in value. In strict mode, this includes additional properties added to the typed array.

property areUrlsEqual

areUrlsEqual: EqualityComparator<Meta>;

• Whether the URLs passed are equal in value.

property getUnsupportedCustomComparator

getUnsupportedCustomComparator:
    | ((
          a: any,
          b: any,
          state: State<Meta>,
          tag: string
      ) => EqualityComparator<Meta> | undefined)
    | undefined;

• Get a custom comparator based on the objects passed.

property circular

circular?: boolean;

• Whether circular references should be supported. It causes the comparison to be slower, but for objects that have circular references it is required to avoid stack overflows.

property createCustomConfig

createCustomConfig?: (
    config: ComparatorConfig<Meta>
) => Partial<ComparatorConfig<Meta>>;

• Create a custom configuration of type-specific equality comparators. This receives the default configuration, which allows either replacement or a superset of the default methods.

property createInternalComparator

createInternalComparator?: (
    compare: EqualityComparator<Meta>
) => InternalEqualityComparator<Meta>;

• Create a custom internal comparator, which is used as an override to the default entry point for nested value equality comparisons. This is often used for doing custom logic for specific types (such as handling a specific class instance differently than other objects) or to incorporate meta in the comparison. See the recipes for examples.

property createState

createState?: () => {
    cache?: Cache<any, any> | undefined;
    meta?: Meta;
};

• Create a custom state object passed between the methods. This allows for custom cache and/or meta values to be used.

property strict

strict?: boolean;

• Whether the equality comparison is strict, meaning it matches all properties (including symbols and non-enumerable properties) with equal shape of descriptors.

property cache

readonly cache: Cache<any, any> | undefined;

• Cache used to identify circular references

property equals

readonly equals: InternalEqualityComparator<Meta>;

• Method used to determine equality of nested value.

property meta

meta: Meta;

• Additional value that can be used for comparisons.

property strict

readonly strict: boolean;

• Whether the equality comparison is strict, meaning it matches all properties (including symbols and non-enumerable properties) with equal shape of descriptors.