Class YatlSearchEngine<T>

Type Parameters

T extends object = UnspecifiedRecord

Index

Constructors

Accessors

data keys scoredSearch searchFields tokenizedSearch tokenizer

Methods

search updateCache

Constructors

constructor

new YatlSearchEngine<T extends object = UnspecifiedRecord>(
options?: YatlSearchOptions<T>,
): YatlSearchEngine<T>
Type Parameters
- T extends object = UnspecifiedRecord
Parameters
- Optionaloptions: YatlSearchOptions<T>
Returns YatlSearchEngine<T>
- Defined in packages/yatl/src/search/search.ts:32

Accessors

data

get data(): T[]
Returns T[]
- Defined in packages/yatl/src/search/search.ts:50
set data(value: T[]): void
Parameters
- value: T[]
Returns void
- Defined in packages/yatl/src/search/search.ts:54

keys

get keys(): NestedKeyOf<T>[]
Returns NestedKeyOf<T>[]
- Defined in packages/yatl/src/search/search.ts:106

scoredSearch

get scoredSearch(): boolean
Returns boolean
- Defined in packages/yatl/src/search/search.ts:70
set scoredSearch(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/yatl/src/search/search.ts:74

searchFields

get searchFields(): YatlFieldSearchOptions<T>[]
Returns YatlFieldSearchOptions<T>[]
- Defined in packages/yatl/src/search/search.ts:59
set searchFields(value: YatlFieldSearchOptions<T>[]): void
Parameters
- value: YatlFieldSearchOptions<T>[]
Returns void
- Defined in packages/yatl/src/search/search.ts:63

tokenizedSearch

get tokenizedSearch(): boolean
Returns boolean
- Defined in packages/yatl/src/search/search.ts:82
set tokenizedSearch(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/yatl/src/search/search.ts:86

tokenizer

get tokenizer(): (value: string) => { quoted: boolean; value: string }[]
Returns (value: string) => { quoted: boolean; value: string }[]
- Defined in packages/yatl/src/search/search.ts:94
set tokenizer(
value: (value: string) => { quoted: boolean; value: string }[],
): void
Parameters
- value: (value: string) => { quoted: boolean; value: string }[]
Returns void
- Defined in packages/yatl/src/search/search.ts:98

Methods

search

search(query: string, subset?: T[]): YatlSearchResult<T>[]
Parameters
- query: string
- Optionalsubset: T[]
Returns YatlSearchResult<T>[]
- Defined in packages/yatl/src/search/search.ts:117

updateCache

updateCache(...items: T[]): void
Parameters
- ...items: T[]
Returns void
- Defined in packages/yatl/src/search/search.ts:110