Interface ObjectByPathOptions<T>
interface ObjectByPathOptions<
T extends { [key: string
| number
| symbol]: any },
> {
customCompareFnMap?: PropertyPathMap<
CompareFn<T>
| DynReducer.Data.Sort<T>,
>;
path?: PropertyPath;
state?: string;
store?: MinimalWritable<ObjectByPathData>;
}
T extends { [key: string
| number
| symbol]: any },
> {
customCompareFnMap?: PropertyPathMap<
CompareFn<T>
| DynReducer.Data.Sort<T>,
>;
path?: PropertyPath;
state?: string;
store?: MinimalWritable<ObjectByPathData>;
}
Type Parameters
- T extends { [key: string | number | symbol]: any }
Hierarchy
- ObjectByPathData
- ObjectByPathOptions (View Summary)
Properties
OptionalcustomCompareFnMap
An property path map with property paths associated with custom compare functions for those keys.
Optionalpath
Current sorted object property if any.
Optionalstate
state?: string
Current sort state:
- `none` no sorting.
- `asc` ascending sort.
- `desc` descending sort.
Optionalstore
An external store that serializes the tracked prop and sorting state as ObjectByPathData.
Defines the options for DynReducerHelper.SortAPI.objectByPath serialized for current property and sort state.