-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
include
index.d.ts
fallback location
- Loading branch information
1 parent
6cfa4cd
commit 6dbbd0d
Showing
2 changed files
with
66 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
import type { | ||
CreateCustomComparatorConfig, | ||
CreateState, | ||
EqualityComparator, | ||
} from './src/internalTypes'; | ||
import { createInternalComparator, sameValueZeroEqual } from './src/utils'; | ||
export { sameValueZeroEqual }; | ||
|
||
interface DefaultEqualCreatorOptions<Meta> { | ||
comparator?: EqualityComparator<Meta>; | ||
circular?: boolean; | ||
strict?: boolean; | ||
} | ||
interface CustomEqualCreatorOptions<Meta> | ||
extends DefaultEqualCreatorOptions<Meta> { | ||
createCustomConfig?: CreateCustomComparatorConfig<Meta>; | ||
createInternalComparator?: typeof createInternalComparator; | ||
createState?: CreateState<Meta>; | ||
} | ||
|
||
/** | ||
* Whether the items passed are deeply-equal in value. | ||
*/ | ||
export declare const deepEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are deeply-equal in value based on strict comparison. | ||
*/ | ||
export declare const strictDeepEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are deeply-equal in value, including circular references. | ||
*/ | ||
export declare const circularDeepEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are deeply-equal in value, including circular references, | ||
* based on strict comparison. | ||
*/ | ||
export declare const strictCircularDeepEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are shallowly-equal in value. | ||
*/ | ||
export declare const shallowEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are shallowly-equal in value based on strict comparison | ||
*/ | ||
export declare const strictShallowEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are shallowly-equal in value, including circular references. | ||
*/ | ||
export declare const circularShallowEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Whether the items passed are shallowly-equal in value, including circular references, | ||
* based on strict comparison. | ||
*/ | ||
export declare const strictCircularShallowEqual: <A, B>(a: A, b: B) => boolean; | ||
/** | ||
* Create a custom equality comparison method. | ||
* | ||
* This can be done to create very targeted comparisons in extreme hot-path scenarios | ||
* where the standard methods are not performant enough, but can also be used to provide | ||
* support for legacy environments that do not support expected features like | ||
* `RegExp.prototype.flags` out of the box. | ||
*/ | ||
export declare function createCustomEqual<Meta>( | ||
options?: CustomEqualCreatorOptions<Meta>, | ||
): <A, B>(a: A, b: B, metaOverride?: Meta) => boolean; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters