Namespace search

Index

Enumerations

FieldType

Interfaces

Type aliases

Functions

Type aliases

Document

Document: { data: string; fields?: Field[]; name: string }

Type declaration

data: string

The data for the document that will be indexed and searched over
Optional fields?: Field[]

The list of fields with the field specific configurations
name: string

The name of the document

Field

Field: { displayName?: string; name: string; type?: FieldType }

Type declaration

Optional displayName?: string

The name of the field that will be used instead of the default name of the field (if provided)
name: string

The name of the field
Optional type?: FieldType

The type of mapping for the field

Functions

createIndex

createIndex(name: string, documents: search.Document[], config: search.Config): Promise<Index>

- Defined in search/index.ts:67
Parameters
- name: string
- documents: search.Document[]
- config: search.Config
Returns Promise<Index>

exists

exists(name: string): Promise<boolean>

- Defined in search/index.ts:83
Parameters
- name: string
Returns Promise<boolean>

openIndex

openIndex(name: string, config: search.Config): Promise<Index>

- Defined in search/index.ts:80
Parameters
- name: string
- config: search.Config
Returns Promise<Index>

Generated using TypeDoc