Class AdminCommandStartedEvent

Event emitted when an admin command is started. This is emitted before the initial HTTP request is made.

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

Hierarchy (view full)

Constructors

constructor

Properties

longRunning method params? path reqBody? timeout

Constructors

constructor

Properties

Readonly longRunning

longRunning: boolean

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

Readonly method

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

The HTTP method for the request.

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.

Optional Readonly reqBody

reqBody?: Record<string, any>

The request body, if any.

Readonly timeout

timeout: number

The timeout for the request, in milliseconds.

Settings

Member Visibility

Theme

On This Page

constructorlongRunningmethodparamspathreqBodytimeout