Interface Context

The Context controller injects custom contextual information into the search requests and usage analytics search events sent from a search interface.

Example: context.ts

interface Context {
    state: ContextState;
    add(contextKey: string, contextValue: ContextValue): void;
    remove(key: string): void;
    set(context: ContextPayload): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- Context

Index

Methods

add remove set subscribe

Properties

state

Methods

add

add(contextKey: string, contextValue: ContextValue): void
Adds (or, if one is already present, replaces) a new context key-value pair.
Parameters
- contextKey: string
  The context key to add.
- contextValue: ContextValue
  The context value to add.
Returns void
- Defined in packages/headless/src/controllers/core/context/headless-core-context.ts:75

remove

remove(key: string): void
Removes a context key from the query.
Parameters
- key: string
  The context key to remove.
Returns void
- Defined in packages/headless/src/controllers/core/context/headless-core-context.ts:81

set

set(context: ContextPayload): void
Sets the context for the query. This replaces any existing context with the new one.
Parameters
- context: ContextPayload
  The context to set for the query.
Returns void
- Defined in packages/headless/src/controllers/core/context/headless-core-context.ts:67

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/src/controllers/controller/headless-controller.ts:11

Properties

state

state: ContextState

The state of the Context controller.

Interface Context

Hierarchy (View Summary)

Index

Methods

Properties

Methods

add

Parameters

Returns void

remove

Parameters

Returns void

set

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribe

Properties

state

Settings

On This Page