Interface QueryError

The QueryError controller allows to retrieve information about the current error returned by the search API, if any.

Example: query-error.fn.tsx

interface QueryError {
state: QueryErrorState;
subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- QueryError

Index

Methods

Properties

Methods

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: QueryErrorState

The state of the QueryError controller.