Class AdminCommandPollingEvent

Event emitted when a command is polling in a long-running operation (i.e. create database).

Emits every time the command polls.

See AdminCommandEvent for more information about all the common properties available on this event.

Hierarchy (view full)

Constructors

constructor

Properties

elapsed interval longRunning method methodName name params? path pollCount reqBody?

Methods

_desc formatted formattedPrefix

Constructors

constructor

Properties

Readonly elapsed

elapsed: number

The elapsed time since the command was started, in milliseconds.

Readonly interval

interval: number

The polling interval, in milliseconds.

Readonly longRunning

longRunning: boolean

Whether the command is long-running or not, i.e. requires polling.

Readonly method

method: "GET" | "POST" | "DELETE"

The HTTP method for the request.

Readonly methodName

methodName: string

The method which invoked the request

Readonly name

name: string

The name of the event.

Optional Readonly params

params?: Record<string, any>

The query parameters, if any.

Readonly path

path: string

The path for the request, not including the Base URL.

Readonly pollCount

pollCount: number

The number of times polled so far

Optional Readonly reqBody

reqBody?: Record<string, any>

The request body, if any.

Methods

Protected _desc

formatted

Static formattedPrefix

Settings

Member Visibility

Theme

On This Page

constructorelapsedintervallongRunningmethodmethodNamenameparamspathpollCountreqBody_descformattedformattedPrefix