Reference NutrientViewerSearchState

Class SearchState

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

You can update the search state using Instance#setSearchState.

Class

Hierarchy

RecordSearchState

Properties

focusedResultIndex

Readonly

number

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

Default Value

-1

isFocused

Readonly

boolean

Indicates that the search input has focus.

isLoading

Readonly

boolean

Indicates that we're currently loading search requests.

minSearchQueryLength

Readonly

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

Readonly

NutrientViewer.Immutable.List<NutrientViewer.SearchResult>

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

term

Readonly

string

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

Immutable Record API

displayName

Static

string

The name provided to Record(values, name) can be accessed with displayName.

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof { … },
        | string
        | number
        | boolean
        | NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
    ],
>"[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 { … },
| string
| number
| boolean
| NutrientViewer.Immutable.List<NutrientViewer.SearchResult>
]
>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 Also
Map#asImmutable
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
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 { … }>(key: K): thisdelete<
    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 { … }extends keyof {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).delete

deleteIn

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

equals

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

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    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 { … }extends keyof {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    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
keystring
notSetValueT
Returns
T
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).get

getIn

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

has

has(
    key: string,
): key is
    | "minSearchQueryLength"
    | "isFocused"
    | "isLoading"
    | "term"
    | "focusedResultIndex"
    | "results"
Parameters
keystring
Returns
key is
| "minSearchQueryLength"
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
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<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, 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, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, 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<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).mergeDeepIn

mergeDeepWith

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

mergeWith

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

removeIn

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

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    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 { … }extends keyof {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Parameters
keyK
value
{ … }[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, }).set

setIn

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

toJS

toJS(): { … }toJS(): {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: unknown;
    term: string;
}
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: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: unknown;
    term: string;
}
focusedResultIndex: number
The currently focused result. -1 if no item is focused yet.

Default Value
-1
isFocused: boolean
Indicates that the search input has focus.

isLoading: boolean
Indicates that we're currently loading search requests.

Readonly
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).

results: unknown
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, }).toJS

toJSON

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 Value
-1
isFocused: boolean
Indicates that the search input has focus.

isLoading: boolean
Indicates that we're currently loading search requests.

Readonly
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).

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(): { … }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 Value
-1
isFocused: boolean
Indicates that the search input has focus.

isLoading: boolean
Indicates that we're currently loading search requests.

Readonly
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).

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 { … },
    | string
    | number
    | boolean
    | NutrientViewer.Immutable.List<NutrientViewer.SearchResult>,
>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 { … },
| string
| number
| boolean
| NutrientViewer.Immutable.List<NutrientViewer.SearchResult>
>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 { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    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 { … }extends keyof {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    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<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).updateIn

wasAltered

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

withMutations

withMutations(mutator: (mutable: this) => unknown): 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) => unknown
Returns
this
See Also
Map#withMutations
Inherited from ImmutableRecord<SearchStateProps>({ isFocused: false, isLoading: false, term: '', focusedResultIndex: -1, results: List(), minSearchQueryLength: 1, }).withMutations

Class SearchState

Hierarchy

Properties

Default Value

Immutable Record API

Returns

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

focusedResultIndex: number

Default Value

isFocused: boolean

isLoading: boolean

ReadonlyminSearchQueryLength: number

results: unknown

term: string

Returns

focusedResultIndex: number

Default Value

isFocused: boolean

isLoading: boolean

ReadonlyminSearchQueryLength: number

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

term: string

Returns

focusedResultIndex: number

Default Value

isFocused: boolean

isLoading: boolean

ReadonlyminSearchQueryLength: number

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

term: string

Returns

Type Parameters

Parameters

Readonly
minSearchQueryLength: number

Readonly
minSearchQueryLength: number

Readonly
minSearchQueryLength: number