Interface PollBlockingOptions

The options representing the blocking behavior of many admin operations.

Field

blocking - True or omitted to block until the operation is complete.

Field

pollInterval - The interval (in MS) at which to poll the operation for completion.

See

AdminBlockingOptions

interface PollBlockingOptions {
    blocking?: true;
    maxTimeMS?: number;
    pollInterval?: number;
}

Hierarchy (view full)

Properties

blocking? maxTimeMS? pollInterval?

Properties

Optional blocking

blocking?: true

True or omitted to block until the operation is complete.

Optional maxTimeMS

maxTimeMS?: number

The maximum time to wait for a response from the server, in milliseconds.

Optional pollInterval

pollInterval?: number

The interval (in MS) at which to poll the operation for completion.

The default is determined on a method-by-method basis.

Settings

Member Visibility

Theme

On This Page

blockingmaxTimeMSpollInterval