Interface InstantResults

The InstantResults controller allows the end user to manage instant results queries.

Example: instant-results.fn.tsx

interface InstantResults {
    state: InstantResultsState;
    clearExpired(): void;
    subscribe(listener: () => void): Unsubscribe;
    updateQuery(q: string): void;
}

Hierarchy (View Summary)

Controller
- InstantResults

Index

Methods

clearExpired subscribe updateQuery

Properties

Methods

clearExpired

clearExpired(): void
Clears all expired instant results queries.

Returns void
- Defined in packages/headless/dist/definitions/controllers/instant-results/instant-results.d.ts:29

subscribe

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

updateQuery

updateQuery(q: string): void
Updates the specified query and shows instant results for it.
Parameters
- q: string
  The query to get instant results for. For more precise instant results, query suggestions are recommended.
Returns void
- Defined in packages/headless/dist/definitions/controllers/instant-results/instant-results.d.ts:25

Properties

state

state: InstantResultsState

The state of the InstantResults controller.