Interface AsyncQueryResult<ItemType>

Response of an asynchronous query.

interface AsyncQueryResult<ItemType> {
cancel?(msg?): void;
total?: Promise<number>;
}

Type Parameters

ItemType extends IndexableThing

Hierarchy

Promise<ResultItems<ItemType>>
- AsyncQueryResult

Index

Properties

Methods

Properties

`Optional` `Readonly` total

total?: Promise<number>

Total number of available items in the result.

Deprecated

transport the 'total' value on the result array.

Methods

`Optional` cancel

cancel(msg?): void
Function to cancel the query.
Parameters
- Optional msg: string
Returns void
Deprecated
Use AbortOptions (AbortSignal)
- Defined in src/main/js/search/store-api/api/Store.ts:47

Generated using TypeDoc