Utilities for comparing and hashing structural objects.
Type declaration
compare:function
compare(x, y): number
Returns the relative order of x with respect to y. Returns -1 if
the entries of object x order lexicographically before the entries of
object y; returns 1 if the entries of object x order
lexicographically after the entries of object y; and returns 0 if x
and y are equal objects. If either x or y is null or undefined,
then objects order before null, and null orders before undefined.
Parameters
x: object
y: object
Returns number
equal:function
equal(x, y): boolean
Returns true if x and y are structurally equal objects; otherwise
returns x === y if either x or y is not an object.
Parameters
x: object
y: object
Returns boolean
equivalent:function
equivalent(x, y, epsilon?): boolean
Returns true if x and y are structurally [[Equivalent.equivalentTo
equivalent]] objects; otherwise returns x === y if either x or y is
not an object.
Parameters
x: object
y: object
Optionalepsilon: number
Returns boolean
getFirstKey:function
getFirstKey<O_3>(object): keyof O_3
Type Parameters
O_3
Parameters
object: O_3
Returns keyof O_3
getFirstValue:function
getFirstValue<O_4>(object): O_4[keyof O_4]
Type Parameters
O_4
Parameters
object: O_4
Returns O_4[keyof O_4]
getNextKey:function
getNextKey<O_5>(object, key): keyof O_5
Type Parameters
O_5
Parameters
object: O_5
key: keyof O_5
Returns keyof O_5
getNextValue:function
getNextValue<O_6>(object, key): O_6[keyof O_6]
Type Parameters
O_6
Parameters
object: O_6
key: keyof O_6
Returns O_6[keyof O_6]
hasAllKeys:function
hasAllKeys<O_1>(object, ...keys): object is O_1
Returns true if object has all of the specified keys,
as determined by key in object. Returns false if object
is undefined or null, or if typeof object is neither
"object" nor "function", or if at least one of specified keys
are not present in object.
Type Parameters
O_1
Parameters
object: unknown
Rest...keys: (keyof O_1)[]
Returns object is O_1
hasAnyKey:function
hasAnyKey<O>(object, ...keys): object is O
Returns true if object has any of the specified keys,
as determined by key in object. Returns false if object
is undefined or null, or if typeof object is neither
"object" nor "function", or if none of the specified keys
are present in object.
Type Parameters
O
Parameters
object: unknown
Rest...keys: (keyof O)[]
Returns object is O
hash:function
hash(x): number
Returns a 32-bit hash value for the entries of object x, if defined;
otherwise returns 0 or 1 if x is undefined or null, respectively.
Parameters
x: object
Returns number
inserted:function
inserted<O_2, K>(object, key, value, target): O_2
Returns a shallow copy of object with the given key-value pair
inserted before the target entry value, in traversal order.
Type Parameters
O_2
K extends string | number | symbol
Parameters
object: O_2
key: K
value: O_2[K]
target: unknown
Returns O_2
isEmpty:function
isEmpty(x): boolean
Returns true if the given object has no own properties.
Utilities for comparing and hashing structural objects.