Home > @i2analyze/i2connect > services > IServiceConfig > async

services.IServiceConfig.async property

Indicates whether the service involves a long-running operation.

Signature:

readonly async?: boolean | {
            pollingIntervalInSeconds?: number;
        };

Returns: boolean | { pollingIntervalInSeconds?: number; }

Introduced: API version 1.0

Remarks

When the property contains a Boolean value, true and false have their traditional meanings.

When the property contains an object, the service does involve a long-running operation, and the i2 Analyze server polls it for progress information at the specified interval.

A service that is configured with the async setting can also specify the asyncState() decorator on one of its parameters.