Interface ContextActionCreators (Open Beta)

The context action creators.

See Dispatch actions.

interface ContextActionCreators {
    setContext(
        payload: SetContextPayload,
    ): { payload: SetContextPayload; type: string };
    setLocation(payload: Required): { payload: Required; type: string };
    setView(payload: SetViewPayload): { payload: SetViewPayload; type: string };
}

Index

Methods

setContext setLocation setView

Methods

setContext

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

setLocation

setLocation(payload: Required): { payload: Required; type: string }
Sets the location context property without modifying any other context properties.
Parameters
- payload: Required
  The action creator payload.
Returns { payload: Required; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/context/context-actions-loader.ts:44

setView

setView(payload: SetViewPayload): { payload: SetViewPayload; type: string }
Sets the view context property without modifying any other context properties.
Parameters
- payload: SetViewPayload
  The action creator payload.
Returns { payload: SetViewPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/context/context-actions-loader.ts:36