Class QueryHandle

Represents a handle to a server-side async query. Provides methods to check status, and cancel the query.

Index

Methods

cancel fetchStatus

Methods

cancel

cancel(_options?: CancelOptions): Promise<void>
Cancels the async query on the server. Does not throw if the query has already been canceled or discarded (404).
Parameters
- Optional_options: CancelOptions
  The options to use for the cancel operation.
Returns Promise<void>
- Defined in lib/querytypes.ts:509

fetchStatus

fetchStatus(_options?: FetchStatusOptions): Promise<QueryStatus>
Fetches the current status of the async query from the server. Returns a QueryStatus describing the query's current state.
Parameters
- Optional_options: FetchStatusOptions
  The options to use for the fetchStatus operation.
Returns Promise<QueryStatus>
Throws
If the query is not found (404).

Throws
If the server reports an error for the query.
- Defined in lib/querytypes.ts:498