Class SearchState

The current state of the search indicators inside the web view.

You can update the search state using Instance#setSearchState.

Hierarchy

Record<
    {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    },
    this,
> & Readonly<
    {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    },
>
- SearchState

Properties

`Readonly`focusedResultIndex

focusedResultIndex: number

The currently focused result. -1 if no item is focused yet.

Default

-1

`Readonly`isFocused

isFocused: boolean

Indicates that the search input has focus.

`Readonly`isLoading

isLoading: boolean

Indicates that we're currently loading search requests.

`Readonly`minSearchQueryLength

minSearchQueryLength: number

Current minimum search query length. When using the UI or the API function NutrientViewer.Instance#search, any query shorter than this number will not be performed.

In Server mode, this value is retrieved from the server at load time.

The default value is 1 (not configurable) in Standalone mode, and 3 in Server mode (configurable in the server).

`Readonly`results

results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>

The latest search results. These will be rendered as highlights in the page view.

`Readonly`term

term: string

The current search term. Changing this term will not start a search. Please use NutrientViewer.Instance#startUISearch for that purpose.

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
        | string
        | number
        | boolean
        | NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
    ],
>
Returns IterableIterator<
    [
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
        | string
        | number
        | boolean
        | NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
    ],
>
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).[iterator]

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).clear

delete

delete<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K,
): this
Returns a new instance of this Record type with the value for the specific key set to its default value.
Type Parameters
- K extends keyof {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }
Parameters
- key: K
Returns this
Alias
remove

Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).delete

deleteIn

deleteIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).equals

get

get<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K,
    notSetValue?: any,
): {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
Type Parameters
- K extends keyof {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }
Parameters
- key: K
- OptionalnotSetValue: any
Returns {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}[K]
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).getIn

has

has(
    key: string,
): key is
    | "isFocused"
    | "isLoading"
    | "term"
    | "focusedResultIndex"
    | "results"
    | "minSearchQueryLength"
Parameters
- key: string
Returns key is
    | "isFocused"
    | "isLoading"
    | "term"
    | "focusedResultIndex"
    | "results"
    | "minSearchQueryLength"
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).has

hashCode

hashCode(): number
Returns number
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).hasIn

merge

merge(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              focusedResultIndex: number;
              isFocused: boolean;
              isLoading: boolean;
              minSearchQueryLength: number;
              results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
              term: string;
          },
      >
  )[]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              focusedResultIndex: number;
              isFocused: boolean;
              isLoading: boolean;
              minSearchQueryLength: number;
              results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
              term: string;
          },
      >
  )[]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              focusedResultIndex: number;
              isFocused: boolean;
              isLoading: boolean;
              minSearchQueryLength: number;
              results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
              term: string;
          },
      >
  )[]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: keyof {
          focusedResultIndex: number;
          isFocused: boolean;
          isLoading: boolean;
          minSearchQueryLength: number;
          results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
          term: string;
      },
  ) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              focusedResultIndex: number;
              isFocused: boolean;
              isLoading: boolean;
              minSearchQueryLength: number;
              results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
              term: string;
          },
      >
  )[]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).mergeWith

remove

remove<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K,
): this
Type Parameters
- K extends keyof {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }
Parameters
- key: K
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).removeIn

set

set<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K,
    value: {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K],
): this
Type Parameters
- K extends keyof {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }
Parameters
- key: K
- value: {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }[K]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).setIn

toJS

toJS(): {
    focusedResultIndex: any;
    isFocused: any;
    isLoading: any;
    minSearchQueryLength: any;
    results: any;
    term: any;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns {
    focusedResultIndex: any;
    isFocused: any;
    isLoading: any;
    minSearchQueryLength: any;
    results: any;
    term: any;
}
- focusedResultIndex: any
  The currently focused result. -1 if no item is focused yet.
  Default
  -1
- isFocused: any
  Indicates that the search input has focus.
- isLoading: any
  Indicates that we're currently loading search requests.
- ReadonlyminSearchQueryLength: any
  Current minimum search query length. When using the UI or the API function NutrientViewer.Instance#search, any query shorter than this number will not be performed.
  
  In Server mode, this value is retrieved from the server at load time.
  
  The default value is 1 (not configurable) in Standalone mode, and 3 in Server mode (configurable in the server).
- results: any
  The latest search results. These will be rendered as highlights in the page view.
- term: any
  The current search term. Changing this term will not start a search. Please use NutrientViewer.Instance#startUISearch for that purpose.
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).toJS

toJSON

toJSON(): {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
- focusedResultIndex: number
  The currently focused result. -1 if no item is focused yet.
  Default
  -1
- isFocused: boolean
  Indicates that the search input has focus.
- isLoading: boolean
  Indicates that we're currently loading search requests.
- ReadonlyminSearchQueryLength: number
  Current minimum search query length. When using the UI or the API function NutrientViewer.Instance#search, any query shorter than this number will not be performed.
  
  In Server mode, this value is retrieved from the server at load time.
  
  The default value is 1 (not configurable) in Standalone mode, and 3 in Server mode (configurable in the server).
- results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>
  The latest search results. These will be rendered as highlights in the page view.
- term: string
  The current search term. Changing this term will not start a search. Please use NutrientViewer.Instance#startUISearch for that purpose.
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).toJSON

toObject

toObject(): {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
- focusedResultIndex: number
  The currently focused result. -1 if no item is focused yet.
  Default
  -1
- isFocused: boolean
  Indicates that the search input has focus.
- isLoading: boolean
  Indicates that we're currently loading search requests.
- ReadonlyminSearchQueryLength: number
  Current minimum search query length. When using the UI or the API function NutrientViewer.Instance#search, any query shorter than this number will not be performed.
  
  In Server mode, this value is retrieved from the server at load time.
  
  The default value is 1 (not configurable) in Standalone mode, and 3 in Server mode (configurable in the server).
- results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>
  The latest search results. These will be rendered as highlights in the page view.
- term: string
  The current search term. Changing this term will not start a search. Please use NutrientViewer.Instance#startUISearch for that purpose.
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).toObject

toSeq

toSeq(): Keyed<
    keyof {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    },
    | string
    | number
    | boolean
    | NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
>
Returns Keyed<
    keyof {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    },
    | string
    | number
    | boolean
    | NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
>
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).toSeq

update

update<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K,
    updater: (
        value: {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        }[K],
    ) => {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K],
): this
Type Parameters
- K extends keyof {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }
Parameters
- key: K
- updater: (
      value: {
          focusedResultIndex: number;
          isFocused: boolean;
          isLoading: boolean;
          minSearchQueryLength: number;
          results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
          term: string;
      }[K],
  ) => {
      focusedResultIndex: number;
      isFocused: boolean;
      isLoading: boolean;
      minSearchQueryLength: number;
      results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
      term: string;
  }[K]
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).update

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).wasAltered

withMutations

withMutations(mutator: (mutable: this) => any): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
- mutator: (mutable: this) => any
Returns this
See
Map#withMutations

Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).withMutations

Class SearchState

Hierarchy

Index

Properties

Methods

Properties

ReadonlyfocusedResultIndex

Default

ReadonlyisFocused

ReadonlyisLoading

ReadonlyminSearchQueryLength

Readonlyresults

Readonlyterm

Methods

[iterator]

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { focusedResultIndex: number; isFocused: boolean; isLoading: boolean; minSearchQueryLength: number; results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>; term: string;}[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is | "isFocused" | "isLoading" | "term" | "focusedResultIndex" | "results" | "minSearchQueryLength"

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

remove

Type Parameters

Parameters

Returns this

removeIn

Parameters

Returns this

set

Type Parameters

`Readonly`focusedResultIndex

`Readonly`isFocused

`Readonly`isLoading

`Readonly`minSearchQueryLength

`Readonly`results

`Readonly`term

Returns {
focusedResultIndex: number;
isFocused: boolean;
isLoading: boolean;
minSearchQueryLength: number;
results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
term: string;
}[K]

Returns key is
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"

Returns {
focusedResultIndex: any;
isFocused: any;
isLoading: any;
minSearchQueryLength: any;
results: any;
term: any;
}

`Readonly`minSearchQueryLength: any

Returns {
focusedResultIndex: number;
isFocused: boolean;
isLoading: boolean;
minSearchQueryLength: number;
results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
term: string;
}

`Readonly`minSearchQueryLength: number

Returns {
focusedResultIndex: number;
isFocused: boolean;
isLoading: boolean;
minSearchQueryLength: number;
results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
term: string;
}

`Readonly`minSearchQueryLength: number

Returns Keyed<
keyof {
focusedResultIndex: number;
isFocused: boolean;
isLoading: boolean;
minSearchQueryLength: number;
results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
term: string;
},
| string
| number
| boolean
| NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
>