Type Alias RemoveDocumentInput

Input for removing a document from the index.

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

Properties

Optional backend override (defaults to configured backend).

Document record to remove.

indexField: string

Field name containing the text to remove from the index.

indexFieldQualified?: string

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

primaryField: string

Field name used as the document id.