Class SearchState

Hierarchy (View Summary)

SearchState
- GlobalSearchState

Index

Constructors

Properties

cachedSearches value

Methods

cache clear getInitialSearch getValue isCached setValue

Constructors

constructor

new SearchState(cachedSearches?: string[]): SearchState
Parameters
- cachedSearches: string[] = []
Returns SearchState
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:5

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
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:41

clear

clear(): void
Clear the search value.

Returns void
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:33

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.

Returns string
See
Search
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:18

getValue

getValue(): string
Returns string
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:22

isCached

isCached(query: string): boolean
Check if this query has been searched before.
Parameters
- query: string
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:48

setValue

setValue(value: string): void
Parameters
- value: string
Returns void
- Defined in flarum/framework/core/js/src/common/states/SearchState.ts:26