@coveo/headless-react
    Preparing search index...

    Interface ExcerptLengthActionCreators

    The excerpt length action creators.

    interface ExcerptLengthActionCreators {
        setExcerptLength(length: number): { payload: number; type: string };
    }
    Index

    Methods

    • Set the length (in number of characters) of the excerpts generated by the indexer based on the keywords present in the query. The index includes the top most interesting sentences (in the order they appear in the item) that fit in the specified number of characters.

      Parameters

      • length: number

        The length of the excerpt

      Returns { payload: number; type: string }

      A dispatchable action.