Class MetronApiError

Thrown for any non-2xx response from the Metron API.

Hierarchy (View Summary)

Error
- MetronApiError
  - MetronRateLimitError

Index

Constructors

Properties

body cause? message name stack? status url

Constructors

constructor

new MetronApiError(
message: string,
options?: { body?: any; status?: number; url?: string },
): MetronApiError
Parameters
- message: string
- Optionaloptions: { body?: any; status?: number; url?: string } = {}
  - Optionalbody?: any
    
    Parsed JSON body, or raw text if the response wasn't JSON.
  - Optionalstatus?: number
    
    HTTP status code.
  - Optionalurl?: string
    
    The request URL that failed.
Returns MetronApiError
Overrides Error.constructor
- Defined in src/errors.js:10

Properties

body

body: any

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

status

status: number | undefined

url

url: string | undefined