Interface RecentQueriesList

The RecentQueriesList controller manages the user's recent queries.

interface RecentQueriesList {
    state: RecentQueriesState;
    clear(): void;
    executeRecentQuery(index: number): void;
    subscribe(listener: () => void): Unsubscribe;
    updateRecentQueries(queries: string[]): void;
}

Hierarchy (View Summary)

Controller
- RecentQueriesList

Index

Methods

clear executeRecentQuery subscribe updateRecentQueries

Properties

Methods

clear

clear(): void
Clears the recent queries list.

Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts:19

executeRecentQuery

executeRecentQuery(index: number): void
Executes the given recent query.
Parameters
- index: number
  The index of the recent query to execute.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts:24

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

updateRecentQueries

updateRecentQueries(queries: string[]): void
Sets the recent queries list to the specified array of queries.
Parameters
- queries: string[]
  The array of queries to set.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts:29

Properties

state

state: RecentQueriesState

The state of the RecentQueriesList controller.