Interface RecentQueriesList

The RecentQueriesList controller manages the user's recent queries.

Example: recent-queries.fn.tsx

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

Hierarchy (View Summary, Expand)

Methods

clear executeRecentQuery subscribe updateRecentQueries

Properties

state

Methods

clear

  • clear(): void

    Clears the recent queries list.

    Returns void

executeRecentQuery

  • executeRecentQuery(index: number): void

    Executes the given recent query.

    Parameters

    • index: number

      The index of the recent query to execute.

    Returns void

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.

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

Properties

state

state: RecentQueriesState

The state of the RecentQueriesList controller.

On This Page

Methods
Properties
MMNEPVFCICPMFPCPTTAAATR