Interface QueryExecution<T>

Container to track a query execution on a queryable source.

interface QueryExecution<T> {
    cancel(): void;
    error?: Error;
    executed: boolean;
    parameters?: any[];
    queryResult?: QueryResult<T>;
    result?: readonly T[];
    run(): Promise<QueryExecution<T>>;
    running: boolean;
    source?: DataSource<T>;
    title: string;
    total?: number;
    waitForExecution(): Promise<QueryExecution<T>>;
    watch(property, cb): WatchHandle;
}

Type Parameters

  • T

Hierarchy (view full)

Properties

error? executed parameters? queryResult? result? running source? title total?

Methods

cancel run waitForExecution watch

Properties

Optional Readonly error

error?: Error

Error to indicate query failures.

Readonly executed

executed: boolean

Indicates that the execution is finished.

Optional parameters

parameters?: any[]

Parameters used to control the query.

Optional Readonly queryResult

queryResult?: QueryResult<T>

Pending query.

Optional Readonly result

result?: readonly T[]

Results of the executed query.

Readonly running

running: boolean

Indicates that the execution is running.

Optional source

source?: DataSource<T>

Source of the query that must have a query method.

title

title: string

Title of the execution.

Optional Readonly total

total?: number

Total number of available items in the result, if the query was paginated

Methods

cancel

  • cancel(): void

  • Function to cancel/stop the current execution.

    Returns void

run

  • run(): Promise<QueryExecution<T>>

  • Function to trigger the execution.

    Returns Promise<QueryExecution<T>>

waitForExecution

  • waitForExecution(): Promise<QueryExecution<T>>

  • Helper function to wait until the execution is finished.

    Returns Promise<QueryExecution<T>>

watch

  • watch(property, cb): WatchHandle

  • Function to watch for changes on a property.

    Parameters

    • property: string

      name of the property to watch

    • cb: WatchCallback<string, any>

      event handler executed on changes

    Returns WatchHandle

Settings

Member Visibility

Theme

On This Page

errorexecutedparametersqueryResultresultrunningsourcetitletotalcancelrunwaitForExecutionwatch

Generated using TypeDoc