@coveo/headless
    Preparing search index...

    Interface FoldingActionCreators

    The folding action creators.

    See Dispatch actions.

    interface FoldingActionCreators {
        loadCollection(
            collectionId: string,
        ): AsyncThunkAction<
            LoadCollectionFulfilledReturn,
            string,
            AsyncThunkSearchOptions<StateNeededByLoadCollection>,
        >;
        registerFolding(
            payload: RegisterFoldingActionCreatorPayload,
        ): { payload: RegisterFoldingActionCreatorPayload; type: string };
    }
    Index

    Methods

    • Loads the results of a collection.

      Parameters

      • collectionId: string

        The collection id to load results for.

      Returns AsyncThunkAction<
          LoadCollectionFulfilledReturn,
          string,
          AsyncThunkSearchOptions<StateNeededByLoadCollection>,
      >

      A dispatchable action.