Interface Search

The Search aptitude provides access to search.

Hierarchy

Search

Index

Methods

Methods

createIndex

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

- Defined in search/index.ts:49
Creates a Search index with the provided configuration and data.

Parameters
- name: string
- documents: search.Document[]
- config: search.Config
  
  The configuration object defines how the index will preform certain searches
Returns Promise<Index>
A Promise resolving with the an Index object.

exists

exists(name: string): Promise<boolean>

- Defined in search/index.ts:64
Verifies a search index exists with the provided name.

Parameters
- name: string
  
  The unique name of the Search Index.
Returns Promise<boolean>
returns true if the index exists with the specified name

openIndex

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

- Defined in search/index.ts:57
Opens an existing search index with the provided configuration.

Parameters
- name: string
- config: search.Config
  
  The configuration object defines how the index will preform certain searches
Returns Promise<Index>
A Promise resolving with the an Index object.

Generated using TypeDoc