Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchState

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SearchState(cachedSearches?: string[]): SearchState

Properties

Protected cachedSearches

cachedSearches: Set<string>

Protected value

value: string = ''

Methods

cache

  • cache(query: string): void

  • Mark that we have already searched for this query so that we don't have to ping the endpoint again.

    Parameters

    • query: string

    Returns void

clear

  • clear(): void

getInitialSearch

  • getInitialSearch(): string

  • If we are displaying the full results of a search (not just a preview), this value should return the query that prompted that search.

    In this generic class, full page searching is not supported. This method should be implemented by subclasses that do support it.

    see

    Search

    Returns string

getValue

  • getValue(): string

isCached

  • isCached(query: string): boolean

setValue

  • setValue(value: string): void

Generated using TypeDoc version 0.22.10