UNPKG

1.57 kBTypeScriptView Raw
1import { DataItem, Value } from './types';
2export declare type Accessors = ReturnType<typeof useAccessors>;
3export declare type DataKeyAccessorFn = (item: DataItem) => DataItem;
4export declare type DataKeyAccessor = string | DataKeyAccessorFn;
5export declare type TextAccessorFn = (item: DataItem) => string;
6export declare type TextAccessor = string | TextAccessorFn;
7export declare const dataValue: (dataItem: DataItem, field?: string | DataKeyAccessorFn | undefined) => unknown;
8export declare const dataText: (dataItem: DataItem, textField?: string | TextAccessorFn | undefined) => string;
9/**
10 * I don't know that the shallow equal makes sense here but am too afraid to
11 * remove it.
12 */
13export declare function valueMatcher(a: DataItem, b: DataItem, dataKey?: DataKeyAccessor): boolean;
14export declare function dataIndexOf(data: readonly DataItem[], value: Value, dataKey?: DataKeyAccessor): number;
15export declare function dataItem<TDataItem = DataItem>(data: readonly TDataItem[], value: Value, dataKey?: DataKeyAccessor): TDataItem;
16export declare const useAccessors: (textField?: string | TextAccessorFn | undefined, dataKey?: string | DataKeyAccessorFn | undefined) => {
17 text: (item: DataItem) => string;
18 value: (item: DataItem) => unknown;
19 indexOf: (data: readonly DataItem[], value: Value) => number;
20 matches: (a: DataItem, b: DataItem) => boolean;
21 findOrSelf: <TDataItem>(data: readonly TDataItem[], value: Value) => TDataItem;
22 includes: (data: readonly DataItem[], value: Value) => boolean;
23};
24//# sourceMappingURL=Accessors.d.ts.map
\No newline at end of file