@coveo/headless
    Preparing search index...

    Interface HighlightParams

    interface HighlightParams {
        closingDelimiter: string;
        content: string;
        highlights: HighlightKeyword[];
        openingDelimiter: string;
    }
    Index

    Properties

    closingDelimiter: string

    The closing delimiter used to close highlighted section.

    content: string

    The string to highlight items in.

    highlights: HighlightKeyword[]

    The highlighted positions to highlight in the string.

    openingDelimiter: string

    The opening delimiter used when starting to highlight.