Class ApiException<T>

Represents an error caused by an api call i.e. it has attributes for a HTTP status code and the returned body object.

Example API returns a ErrorMessageObject whenever HTTP status code is not in [200, 299] => ApiException(404, someErrorMessageObject)

Type Parameters

T

Hierarchy

Error
- ApiException

Index

Constructors

Properties

body code message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new ApiException<T>(code: number, body: T): ApiException<T>
Type Parameters
- T
Parameters
- code: number
- body: T
Returns ApiException<T>
Overrides Error.constructor
- Defined in packages/datadog-api-client-common/exception.ts:11

Properties

body

body: T

code

code: number

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc