Class AdminCommandSucceededEvent

Event emitted when an admin command has succeeded, after any necessary polling.

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

Hierarchy (view full)

Constructors

constructor

Properties

duration longRunning method methodName name params? path reqBody? resBody?

Methods

_desc formatted formattedPrefix

Constructors

constructor

Properties

Readonly duration

duration: number

The duration of the command, 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.

Optional Readonly reqBody

reqBody?: Record<string, any>

The request body, if any.

Optional Readonly resBody

resBody?: Record<string, any>

The response body of the command, if any.

Methods

Protected _desc

formatted

Static formattedPrefix

Settings

Member Visibility

Theme

On This Page

constructordurationlongRunningmethodmethodNamenameparamspathreqBodyresBody_descformattedformattedPrefix