gnezim
65 lines
1.6 KiB
TypeScript
65 lines
1.6 KiB
TypeScript
// Type definitions for Fuse.js v3.6.1
|
|
// TypeScript Version: 3.1
|
|
|
|
export = Fuse;
|
|
export as namespace Fuse;
|
|
|
|
interface SearchOpts {
|
|
limit?: number;
|
|
}
|
|
|
|
declare class Fuse<T, O extends Fuse.FuseOptions<T>> {
|
|
constructor(list: ReadonlyArray<T>, options?: O);
|
|
search<
|
|
/** Type of item of return */
|
|
R = O extends { id: string } ? string : T,
|
|
/** include score (boolean) */
|
|
S = O["includeScore"],
|
|
/** include matches (boolean) */
|
|
M = O["includeMatches"]
|
|
>(
|
|
pattern: string,
|
|
opts?: SearchOpts
|
|
): S extends true
|
|
? M extends true
|
|
? (Fuse.FuseResultWithMatches<R> & Fuse.FuseResultWithScore<R>)[]
|
|
: Fuse.FuseResultWithScore<R>[]
|
|
: M extends true
|
|
? Fuse.FuseResultWithMatches<R>[]
|
|
: R[];
|
|
|
|
setCollection(list: ReadonlyArray<T>): ReadonlyArray<T>;
|
|
list: ReadonlyArray<T>;
|
|
}
|
|
|
|
declare namespace Fuse {
|
|
export interface FuseResultWithScore<T> {
|
|
item: T;
|
|
score: number;
|
|
}
|
|
export interface FuseResultWithMatches<T> {
|
|
item: T;
|
|
matches: any;
|
|
}
|
|
export interface FuseOptions<T> {
|
|
id?: keyof T | string;
|
|
caseSensitive?: boolean;
|
|
includeMatches?: boolean;
|
|
includeScore?: boolean;
|
|
shouldSort?: boolean;
|
|
sortFn?: (a: { score: number }, b: { score: number }) => number;
|
|
getFn?: (obj: any, path: string) => any;
|
|
keys?: (keyof T | string)[] | { name: keyof T | string; weight: number }[];
|
|
verbose?: boolean;
|
|
tokenize?: boolean;
|
|
tokenSeparator?: RegExp;
|
|
matchAllTokens?: boolean;
|
|
location?: number;
|
|
distance?: number;
|
|
threshold?: number;
|
|
maxPatternLength?: number;
|
|
minMatchCharLength?: number;
|
|
findAllMatches?: boolean;
|
|
}
|
|
}
|