Home > @i2analyze/i2connect > asyncState

asyncState() function

The @asyncState decorator, which configures a service method parameter to receive an IAsyncState object.

Signature:

export declare function asyncState(): ParameterDecorator;

Returns:

ParameterDecorator

Introduced: API version 1.0

Remarks

The IAsyncState interface provides access to additional communication between the connector and the client.

For example, the connector can call IAsyncState.isCanceled to determined whether the user has canceled the query. The connector can also set substatuses to provide detailed feedback to the user about a long-running query.