Class IndexService<T>

index service

Type parameters

T

Hierarchy

IndexService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IndexService<T>(all: T[], terms: IIndexTerm<T>[], builder: IndexServiceBuilder<T>): IndexService<T>

- Defined in IndexService.ts:11
Type parameters
- T
Parameters
- all: T[]
- terms: IIndexTerm<T>[]
- builder: IndexServiceBuilder<T>
Returns IndexService<T>

Properties

Readonly all

all: T[]

Private emptyQueryResults

emptyQueryResults: IIndexSearchResultItem<T>[]

Methods

build

build(items: T[]): IndexService<T>

- Defined in IndexService.ts:84
Build another service with the same term builders

Parameters
- items: T[]
  
  items to index
Returns IndexService<T>

search

search(query?: string, options?: IIndexSearchOptions): IIndexSearchResultItem<T>[]

- Defined in IndexService.ts:27
search the index

Parameters
- Optional query: string
  
  text to find
- Optional options: IIndexSearchOptions
  
  search options
Returns IIndexSearchResultItem<T>[]
array of item results

Generated using TypeDoc