Type alias AdminCommandEvents

AdminCommandEvents: {
    adminCommandFailed: ((event) => void);
    adminCommandPolling: ((event) => void);
    adminCommandStarted: ((event) => void);
    adminCommandSucceeded: ((event) => void);
}

The events emitted by the DataAPIClient. These events are emitted at various stages of the admin command's lifecycle. Intended for use for monitoring and logging purposes.

Type declaration

  • adminCommandFailed: ((event) => void)

    Emitted when an admin command has errored.

  • adminCommandPolling: ((event) => void)

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

  • adminCommandStarted: ((event) => void)

    Emitted when an admin command is started, before the initial HTTP request is made.

  • adminCommandSucceeded: ((event) => void)

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

Settings

Member Visibility

Theme