Interface SearchOptsHook

Hierarchy

Properties

debounce? filters? include? limit? scope?

Properties

Optional debounce

debounce?: number

Debouncing makes queries slower, but prevents sending many request. Number respresents milliseconds.

Optional filters

filters?: { [propertyShortname: string]: string }

Property-Value pair of set filters. For now, use the shortname of the property as the key.

Type declaration

  • [propertyShortname: string]: string

Optional include

include?: boolean

Fetch full resources instead of subjects

Optional limit

limit?: number

Max of how many results to return

Optional scope

scope?: string

Subject of resource to scope the search to. This should be a parent of the resources you're looking for.

Settings

Member Visibility

Theme

Generated using TypeDoc