Interface DictionaryFieldContextActionCreators

The dictionary field context action creators.

interface DictionaryFieldContextActionCreators {
    addContext(
        payload: AddDictionaryFieldContextActionCreatorPayload,
    ): { payload: AddDictionaryFieldContextActionCreatorPayload; type: string };
    removeContext(field: string): { payload: string; type: string };
    setContext(
        payload: DictionaryFieldContextPayload,
    ): { payload: P; type: string };
}

Index

Methods

addContext removeContext setContext

Methods

addContext

addContext(
payload: AddDictionaryFieldContextActionCreatorPayload,
): { payload: AddDictionaryFieldContextActionCreatorPayload; type: string }
Adds a new dictionary field context field-key pair.
Parameters
- payload: AddDictionaryFieldContextActionCreatorPayload
  The action creator payload.
Returns { payload: AddDictionaryFieldContextActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/dictionary-field-context/dictionary-field-context-actions-loader.d.ts:19

removeContext

removeContext(field: string): { payload: string; type: string }
Removes a dictionary field context field-key pair.
Parameters
- field: string
  The field to remove from the context (e.g., "price").
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/dictionary-field-context/dictionary-field-context-actions-loader.d.ts:26

setContext

setContext(payload: DictionaryFieldContextPayload): { payload: P; type: string }
Sets the dictionary field context.
Parameters
- payload: DictionaryFieldContextPayload
  The action creator payload.
Returns { payload: P; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/dictionary-field-context/dictionary-field-context-actions-loader.d.ts:33