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

ReadonlyImmutableRecordSearchState

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.

Methods

entries

entries(): IterableIterator<[string, unknown]>
Returns the record's [key, value] pairs, in the order its fields were defined.

Returns
IterableIterator<[string, unknown]>
An iterator over the record's fields.

Immutable Record API

[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>,
    ],
>
Iterates the [key, value] pairs, in the order the fields were defined.

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>,
    ],
>

clear

clear(): this
Returns a record with every key reset to the default it was defined with.

Returns
this
A new record holding only default values.

delete

delete<K extends keyof { … }>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
): thisdelete<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
): this
Returns a record with key reset to the default it was defined with.

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 & (
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"
)
One of the keys this record was defined with.

Returns
this
A new record, or this one when the value already equals the default.

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Returns a record with the value at keyPath removed. A field of this record is reset to its default; a key of a nested collection or plain object is deleted.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
this
A new record, or this one when nothing was removed.

equals

Deprecated

equals(other: unknown): boolean
Reports whether other is a record holding the same keys with equal values, whatever its class.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when both hold the same keys and every value matches.

Deprecated
Records of different classes with identical values compare equal. Use isEqual(), which also requires both records to be of the same class.

get

get<K extends keyof { … }, N = never>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
    notSetValue?: N,
): N | { … }[K]get<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
    N = never,
>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
    notSetValue?: N,
):
    | N
    | {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K]
Returns the value stored under key.

Type Parameters
K
extends keyof { … }extends keyof {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
N = never
Parameters
keyK & (
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"
)
One of the keys this record was defined with.

notSetValueN
Optional
Returned when the record does not define key.

Returns
N | { … }[K]
    | N
    | {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K]
The current value for that key.

getIn

getIn(keyPath: Iterable<unknown>): unknown
Returns the value at keyPath, walking nested records and collections.

A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
unknown
The value at that path, or undefined when it does not resolve.
getIn<N>(keyPath: Iterable<unknown>, notSetValue: N): unknown
Returns the value at keyPath, walking nested records and collections.

A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

Type Parameters
N
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueN
Returned when the path does not resolve.

Returns
unknown
The value at that path, or notSetValue.

has

has(
    key: string,
): key is
    | "isFocused"
    | "isLoading"
    | "term"
    | "focusedResultIndex"
    | "results"
    | "minSearchQueryLength"
Reports whether key is one of the keys this record was defined with.

A literal key must name a field; a key typed as string is narrowed to the field names.

Parameters
keystring
The key to look for.

Returns
key is
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"
true when the record defines that key, even if its value is null.

hashCode

hashCode(): number
Computes a hash of this record from its contents, the same way Immutable.js does. Equal records have equal hashes; records with equal hashes are not necessarily equal. Plain objects, functions and symbols hash by identity, so a hash is only meaningful within the page that computed it.

Returns
number
An integer hash.

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Reports whether keyPath resolves, walking nested records and collections.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
boolean
true when every key along the path is present.

isEqual

isEqual(other: unknown): boolean
Reports whether other is a record of the same class holding equal values. Only the two records' own classes are compared; nested records compare as equals() does.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when both are the same class and every value matches.

merge

merge(
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismerge(
    ...collections: (
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection applied in order.

Keys the record was not defined with are ignored.

Parameters
...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to apply.

Returns
this
A new record, or this one when no value changed.

mergeDeep

mergeDeep(
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeDeep(
    ...collections: (
        | Partial<
            {
                isFocused: boolean;
                isLoading: boolean;
                term: string;
                focusedResultIndex: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                minSearchQueryLength: number;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in, recursing into nested collections and plain objects instead of replacing them.

Keys the record was not defined with are ignored.

Parameters
...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            isFocused: boolean;
            isLoading: boolean;
            term: string;
            focusedResultIndex: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            minSearchQueryLength: number;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Returns a record with each collection merged deeply into the value at keyPath.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
this
A new record, or this one when the value is unchanged.

mergeDeepWith

mergeDeepWith(
    merger: (previous: unknown, next: unknown, key: unknown) => unknown,
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeDeepWith(
    merger: (previous: unknown, next: unknown, key: unknown) => unknown,
    ...collections: (
        | Partial<
            {
                isFocused: boolean;
                isLoading: boolean;
                term: string;
                focusedResultIndex: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                minSearchQueryLength: number;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in deeply, calling merger where a nested value is not a collection to decide the value that is kept.

Keys the record was not defined with are ignored.

Parameters
merger(previous: unknown, next: unknown, key: unknown) => unknown
Receives the current value, the incoming value and the key.

...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            isFocused: boolean;
            isLoading: boolean;
            term: string;
            focusedResultIndex: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            minSearchQueryLength: number;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Returns a record with each collection merged into the value at keyPath, one level at a time.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
this
A new record, or this one when the value is unchanged.

mergeWith

mergeWith(
    merger: <K extends string | number | symbol>(
        previous: { … }[K],
        next: { … }[K],
        key: K,
    ) => { … }[K],
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeWith(
    merger: <K extends string | number | symbol>(
        previous: {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        }[K],
        next: {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        }[K],
        key: K,
    ) => {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K],
    ...collections: (
        | Partial<
            {
                focusedResultIndex: number;
                isFocused: boolean;
                isLoading: boolean;
                minSearchQueryLength: number;
                results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
                term: string;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in, calling merger for each key the record already holds to decide the value that is kept.

Keys the record was not defined with are ignored.

Parameters
merger
<K extends string | number | symbol>(
previous: { … }[K],
next: { … }[K],
key: K
) => { … }[K]<K extends string | number | symbol>(
    previous: {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K],
    next: {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K],
    key: K,
) => {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}[K]
Receives the current value, the incoming value and the key.

...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

remove

remove<K extends keyof { … }>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
): thisremove<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
): this
An alias for delete.

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 & (
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"
)
One of the keys this record was defined with.

Returns
this
A new record, or this one when the value already equals the default.

removeIn

removeIn(keyPath: Iterable<unknown>): this
An alias for deleteIn.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
this
A new record, or this one when nothing was removed.

set

set<K extends keyof { … }>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
    value: { … }[K],
): thisset<
    K extends
        keyof {
            focusedResultIndex: number;
            isFocused: boolean;
            isLoading: boolean;
            minSearchQueryLength: number;
            results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
            term: string;
        },
>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
    value: {
        focusedResultIndex: number;
        isFocused: boolean;
        isLoading: boolean;
        minSearchQueryLength: number;
        results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
        term: string;
    }[K],
): this
Returns a record with key set to value.

Setting a key to the value it already holds returns the same instance, so a record can be compared by reference to detect a change.

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 & (
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"
)
One of the keys this record was defined with.

value
{ … }[K]{
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}[K]
The value to store.

Returns
this
A new record, or this one when the value is unchanged or the key is not defined.

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Returns a record with value written at keyPath.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

valueunknown
The value to store.

Returns
this
A new record, or this one when the value is unchanged.

toJS

toJS(): { … }toJS(): {
    isFocused: boolean;
    isLoading: boolean;
    term: string;
    focusedResultIndex: number;
    results: {
        pageIndex: number
        | null;
        previewText: string;
        locationInPreview: number | null;
        lengthInPreview: number | null;
        rectsOnPage: { left: number; top: number; width: number; height: number }[];
        isAnnotation: boolean | null;
        annotationRect?:
            | { left: number; top: number; width: number; height: number }
            | null;
    }[];
    minSearchQueryLength: number;
}
Converts this record and everything nested inside it to plain JavaScript values.
Returns
{ … }{
    isFocused: boolean;
    isLoading: boolean;
    term: string;
    focusedResultIndex: number;
    results: {
        pageIndex: number | null;
        previewText: string;
        locationInPreview: number | null;
        lengthInPreview: number | null;
        rectsOnPage: { left: number; top: number; width: number; height: number }[];
        isAnnotation: boolean | null;
        annotationRect?:
            | { left: number; top: number; width: number; height: number }
            | null;
    }[];
    minSearchQueryLength: number;
}
A plain object holding this record's values, converted all the way down.

isFocused: boolean
Indicates that the search input has focus.

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

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

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

Default Value
-1
results: {
    pageIndex: number | null;
    previewText: string;
    locationInPreview: number | null;
    lengthInPreview: number | null;
    rectsOnPage: { left: number; top: number; width: number; height: number }[];
    isAnnotation: boolean | null;
    annotationRect?:
        | { left: number; top: number; width: number; height: number }
        | null;
}[]
The latest search results. These will be rendered as highlights in the page view.

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

toJSON

toJSON(): { … }toJSON(): {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
An alias for toObject, called by JSON.stringify.
Returns
{ … }{
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
A plain object holding this record's values.

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.

toObject

toObject(): { … }toObject(): {
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
Converts this record to a plain object, one level deep. Nested records are left as they are.
Returns
{ … }{
    focusedResultIndex: number;
    isFocused: boolean;
    isLoading: boolean;
    minSearchQueryLength: number;
    results: NutrientViewer.Immutable.List<NutrientViewer.SearchResult>;
    term: string;
}
A plain object holding this record's values.

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.

update

update<K extends keyof { … }>(
    key: K & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
    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 & (
        | "isFocused"
        | "isLoading"
        | "term"
        | "focusedResultIndex"
        | "results"
        | "minSearchQueryLength"
    ),
    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
Returns a record with key replaced by the result of applying updater to its current 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 & (
| "isFocused"
| "isLoading"
| "term"
| "focusedResultIndex"
| "results"
| "minSearchQueryLength"
)
One of the keys this record was defined with.

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]
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

updateIn

updateIn<N>(
    keyPath: Iterable<unknown>,
    notSetValue: N,
    updater: (value: unknown) => unknown,
): this
Returns a record with the value at keyPath replaced by the result of updater.

Type Parameters
N
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueN
updater(value: unknown) => unknown
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Returns a record with the value at keyPath replaced by the result of updater.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

updater(value: unknown) => unknown
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Applies several changes as one, so only a single new record is allocated.

The record handed to mutator may be written to with set; it is frozen again once mutator returns.

Parameters
mutator(mutable: this) => unknown
Receives a temporarily writable copy of this record.

Returns
this
A new record holding the applied changes, or this one when nothing changed.

Class SearchState

Hierarchy

Properties

Default Value

Methods

Returns

Immutable Record API

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

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

isFocused: boolean

isLoading: boolean

term: string

focusedResultIndex: number

Default Value

ReadonlyminSearchQueryLength: number

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

Type Parameters

Parameters

Returns

Readonly
minSearchQueryLength: number

Readonly
minSearchQueryLength: number

Readonly
minSearchQueryLength: number