Interface ContextActionCreators

The context action creators.

See Dispatch actions.

interface ContextActionCreators {
    addContext(
        payload: AddContextActionCreatorPayload,
    ): { payload: AddContextActionCreatorPayload; type: string };
    removeContext(key: string): { payload: string; type: string };
    setContext(
        payload: ContextPayload,
    ): { payload: ContextPayload; type: string };
}

Index

Methods

addContext removeContext setContext

Methods

addContext

addContext(
payload: AddContextActionCreatorPayload,
): { payload: AddContextActionCreatorPayload; type: string }
Adds a new context value.
Parameters
- payload: AddContextActionCreatorPayload
  The action creator payload.
Returns { payload: AddContextActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/context/context-actions-loader.ts:27

removeContext

removeContext(key: string): { payload: string; type: string }
Removes a context key-value pair.
Parameters
- key: string
  The key to remove from the context (e.g., "age").
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/context/context-actions-loader.ts:37

setContext

setContext(payload: ContextPayload): { payload: ContextPayload; type: string }
Sets the query context.
Parameters
- payload: ContextPayload
  The action creator payload.
Returns { payload: ContextPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/context/context-actions-loader.ts:45