@resistdesign/voltra
    Preparing search index...

    Type Alias ReplaceDocumentInput

    Input for replacing a document in the index.

    type ReplaceDocumentInput = {
        backend?: IndexBackend;
        indexField: string;
        indexFieldQualified?: string;
        nextDocument: DocumentRecord;
        previousDocument: DocumentRecord;
        primaryField: string;
    }
    Index

    Properties

    backend? indexField indexFieldQualified? nextDocument previousDocument primaryField

    Properties

    backend?: IndexBackend

    Optional backend override (defaults to configured backend).

    indexField: string

    Field name containing the text to index.

    indexFieldQualified?: string

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

    nextDocument: DocumentRecord

    Next document record to index.

    previousDocument: DocumentRecord

    Previous document record to remove.

    primaryField: string

    Field name used as the document id.

    Settings

    Member Visibility

    On This Page

    Properties