Function getStoredFields

Returns the stored fields (as configured in the storeFields constructor option) for the given document ID. Returns undefined if the document is not present in the index.

  • getStoredFields<
        ID,
        Document,
        Index extends Record<string, any> = Record<never, never>,
    >(
        searchIndex: SearchIndex<ID, Document, Index>,
        id: ID,
    ): undefined | Index

  • Type Parameters

    • ID

      The id type of the documents being indexed.

    • Document

      The type of the documents being indexed.

    • Index extends Record<string, any> = Record<never, never>

      The type of the documents being indexed.

    Parameters

    Returns undefined | Index

    The stored document index

Settings

Member Visibility