Class FullTextSearch

Hierarchy

FullTextSearch

Index

Interfaces

Constructors

constructor

Methods

Constructors

constructor

new FullTextSearch(fieldOptions?: FieldOptions[], id?: string): FullTextSearch

- Defined in full-text-search/src/full_text_search.ts:22
Initialize the full-text search for the given fields.

Parameters
- Default value fieldOptions: FieldOptions[] = []
  
  the field options
- Optional id: string
Returns FullTextSearch

Methods

addDocument

addDocument(doc: object, id?: InvertedIndex.DocumentIndex): void

- Defined in full-text-search/src/full_text_search.ts:46
Parameters
- doc: object
- Default value id: InvertedIndex.DocumentIndex = doc[this._id]
Returns void

clear

clear(): void

- Defined in full-text-search/src/full_text_search.ts:82
Returns void

removeDocument

removeDocument(doc: object, id?: InvertedIndex.DocumentIndex): void

- Defined in full-text-search/src/full_text_search.ts:68
Parameters
- doc: object
- Default value id: InvertedIndex.DocumentIndex = doc[this._id]
Returns void

search

search(query: Query): Scorer.ScoreResults

- Defined in full-text-search/src/full_text_search.ts:88
Parameters
- query: Query
Returns Scorer.ScoreResults

toJSON

toJSON(): Serialization

- Defined in full-text-search/src/full_text_search.ts:92
Returns Serialization

updateDocument

updateDocument(doc: object, id?: InvertedIndex.DocumentIndex): void

- Defined in full-text-search/src/full_text_search.ts:77
Parameters
- doc: object
- Default value id: InvertedIndex.DocumentIndex = doc[this._id]
Returns void

Static fromJSONObject

fromJSONObject(serialized: Serialization, analyzers?: Dict<Analyzer>): FullTextSearch

- Defined in full-text-search/src/full_text_search.ts:102
Parameters
- serialized: Serialization
- Default value analyzers: Dict<Analyzer> = {}
Returns FullTextSearch

Static register

register(): void

- Defined in full-text-search/src/full_text_search.ts:20
Registers the full-text search as plugin.

Returns void

Generated using TypeDoc