Interface DictionaryFieldContext

The DictionaryFieldContext controller allows specifying which dictionary field keys to retrieve.

Example: dictionary-field-context.fn.ts

interface DictionaryFieldContext {
    state: DictionaryFieldContextState;
    add(field: string, key: string): void;
    remove(field: string): void;
    set(context: DictionaryFieldContextPayload): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- DictionaryFieldContext

Index

Methods

add remove set subscribe

Properties

Methods

add

add(field: string, key: string): void
Adds (or, if one is already present, replaces) a new dictionary field context key-value pair.
Parameters
- field: string
  The dictionary field name.
- key: string
  The dictionary field key for which to retrieve a value.
Returns void
- Defined in packages/headless/dist/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts:26

remove

remove(field: string): void
Removes a dictionary field from the query.
Parameters
- field: string
  The field to remove.
Returns void
- Defined in packages/headless/dist/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts:31

set

set(context: DictionaryFieldContextPayload): void
Sets the dictionary field context for the query. This replaces any existing context with the new one.
Parameters
- context: DictionaryFieldContextPayload
  The dictionary field context to set for the query.
Returns void
- Defined in packages/headless/dist/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts:19

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: DictionaryFieldContextState

The state of the DictionaryFieldContext controller.