• Public
  • Public/Protected
  • All


Type aliases

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: { 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


  • exists(name: string): Promise<boolean>

Generated using TypeDoc