Type Alias IndexDocumentInput

Input for indexing a document.

type IndexDocumentInput = {
    backend?: IndexBackend;
    document: DocumentRecord;
    indexField: string;
    indexFieldQualified?: string;
    primaryField: string;
}

Index

Properties

backend? document indexField indexFieldQualified? primaryField

Properties

`Optional`backend

backend?: IndexBackend

Optional backend override (defaults to configured backend).

document

document: DocumentRecord

Document record to index.

indexField

indexField: string

Field name containing the text to index.

`Optional`indexFieldQualified

indexFieldQualified?: string

Optional index field key to use for persistence when the index key should be type-qualified. Defaults to indexField.

primaryField

primaryField: string

Field name used as the document id.