Interface SortAPI
interface SortAPI {
objectByPath: <T extends { [key: string | number | symbol]: any }>(
options?: ObjectByPathOptions<T>,
) => ObjectByPath<T>;
}
objectByPath: <T extends { [key: string | number | symbol]: any }>(
options?: ObjectByPathOptions<T>,
) => ObjectByPath<T>;
}
Properties
objectByPath
objectByPath: <T extends { [key: string | number | symbol]: any }>(
options?: ObjectByPathOptions<T>,
) => ObjectByPath<T>
options?: ObjectByPathOptions<T>,
) => ObjectByPath<T>
Creates an instance of Sort.ObjectByPath which is a managed sorting mechanism for dynamic reducers providing several default sort comparisons for object properties with additional customization for complex data types.
Note that either a store with Sort.ObjectByPathData should be provided or initial prop and state
values specified for the internal store.
Type Declaration
-
- <T extends { [key: string | number | symbol]: any }>(
options?: ObjectByPathOptions<T>,
): ObjectByPath<T> -
Type Parameters
- T extends { [key: string | number | symbol]: any }
Parameters
Optionaloptions: ObjectByPathOptions<T>ObjectByPath options.
Returns ObjectByPath<T>
- <T extends { [key: string | number | symbol]: any }>(
All available sort functions.