Function compareProperties
- compareProperties<
const K extends
string
| number
| symbol
| ComparePropertiesArrayElement<E>[],
E extends
object = Record<
GetPropertiesFromComparePropertiesKeys<K>,
ComparableType,
>,
>(
fields: K,
): (lhs: E, rhs: E) => number & {
partialCompare: <
T extends
| (
([unknown] | [ComparePropertiesArrayElement<E>]) & (string | number | symbol)
)
| (
([unknown] | [ComparePropertiesArrayElement<E>]) & [ComparePropertiesArrayElement<E>, ...ComparePropertiesArrayElement<E>[]]
),
>(
partialFields: T,
) => (lhs: E, rhs: E) => number & {
partialCompare: <
T extends
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>]) & (string | number | symbol)
)
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>]) & [ComparePropertiesArrayElement<E>, ...ComparePropertiesArrayElement<...>[]]
),
>(
partialFields: T,
) => (lhs: E, rhs: E) => number & {
partialCompare: <
T extends
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>] | [(string | ComparePropertiesArrayElement<...>) & ComparePropertiesArrayElement<...>]) & (string | ... 1 more ... | symbol)
)
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>] | [(string | ComparePropertiesArrayElement<...>) & ComparePropertiesArrayElement<...>]) & [...]
),
>(
partialFields: T,
) => (lhs: ..., rhs: ...) => ... & { partialCompare: ... };
};
};
}Type Parameters
- const K extends string | number | symbol | ComparePropertiesArrayElement<E>[]
- E extends object = Record<GetPropertiesFromComparePropertiesKeys<K>, ComparableType>
Parameters
- fields: K
Field selector(s) defining compare priority and optional direction.
Returns (lhs: E, rhs: E) => number & {
partialCompare: <
T extends
| (
([unknown] | [ComparePropertiesArrayElement<E>]) & (string | number | symbol)
)
| (
([unknown] | [ComparePropertiesArrayElement<E>]) & [ComparePropertiesArrayElement<E>, ...ComparePropertiesArrayElement<E>[]]
),
>(
partialFields: T,
) => (lhs: E, rhs: E) => number & {
partialCompare: <
T extends
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>]) & (string | number | symbol)
)
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>]) & [ComparePropertiesArrayElement<E>, ...ComparePropertiesArrayElement<...>[]]
),
>(
partialFields: T,
) => (lhs: E, rhs: E) => number & {
partialCompare: <
T extends
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>] | [(string | ComparePropertiesArrayElement<...>) & ComparePropertiesArrayElement<...>]) & (string | ... 1 more ... | symbol)
)
| (
([unknown] | [ComparePropertiesArrayElement<E>] | [string | ComparePropertiesArrayElement<E>] | [(string | ComparePropertiesArrayElement<...>) & ComparePropertiesArrayElement<...>]) & [...]
),
>(
partialFields: T,
) => (lhs: ..., rhs: ...) => ... & { partialCompare: ... };
};
};
}A compare callback suitable for Array.prototype.sort, extended with
partialCompare(...)to create a comparator for a prefix of the same key sequence.
Build a comparator function for objects using one or more comparable properties. This is extremely useful as a type-safe comparator for sort/toSorted APIs, especially when dealing with multiple or non-string keys.
Keys can be provided as:
Comparison is performed in order until the first non-zero result.