Type alias DataAPIWarningDescriptor

DataAPIWarningDescriptor: DataAPIErrorDescriptor & {
    scope: "WARNING";
}
Overview

A specialized subset of DataAPIErrorDescriptor that represents a warning returned by the Data API.

This represents a warning that occurred during the operation which should likely be addressed by the user, but had no actual impact on the success or failure of the operation itself.

⚠️Note: This is identical to the DataAPIErrorDescriptor in every way, except DataAPIErrorDescriptor.scope is always 'WARNING'.

Type declaration

  • scope: "WARNING"

See

  • CommandWarningEvent
  • AdminCommandWarningEvent

Settings

Member Visibility

Theme

On This Page

Overview