@resistdesign/voltra
    Preparing search index...

    Class FullTextS3Backend

    S3 implementation of the generic full-text indexing contracts.

    Implements

    Index

    Methods

    • Add exact token positions for a document.

      Parameters

      • token: string

        Token to add.

      • indexField: string

        Field name the token was indexed under.

      • docId: DocId

        Document id to associate.

      • positions: number[]

        Token positions within the document.

      Returns Promise<void>

      Promise resolved when positions are written.

    • Add a lossy posting for a token.

      Parameters

      • token: string

        Token to add.

      • indexField: string

        Field name the token was indexed under.

      • docId: DocId

        Document id to associate.

      Returns Promise<void>

      Promise resolved when the posting is written.

    • Load exact positions for a token in a document.

      Parameters

      • token: string

        Token to load positions for.

      • indexField: string

        Field name the token was indexed under.

      • docId: DocId

        Document id containing the token.

      Returns Promise<number[] | undefined>

      Positions array or undefined if not present.

    • Load lossy postings for a token.

      Parameters

      • token: string

        Token to load postings for.

      • indexField: string

        Field name the token was indexed under.

      Returns Promise<DocId[]>

      Array of document ids containing the token.

    • Load token statistics for a token.

      Parameters

      • token: string

        Token to load stats for.

      • indexField: string

        Field name the token was indexed under.

      Returns Promise<TokenStats | undefined>

      Token stats or undefined when missing.

    • Remove exact token positions for a document.

      Parameters

      • token: string

        Token to remove.

      • indexField: string

        Field name the token was indexed under.

      • docId: DocId

        Document id to disassociate.

      Returns Promise<void>

      Promise resolved when positions are removed.

    • Remove a lossy posting for a token.

      Parameters

      • token: string

        Token to remove.

      • indexField: string

        Field name the token was indexed under.

      • docId: DocId

        Document id to disassociate.

      Returns Promise<void>

      Promise resolved when the posting is removed.