Class ApiError<Body>

Type Parameters

Body

Hierarchy (view full)

Error
- ApiError
  - ValidationError

Index

Constructors

Properties

body requestId status timeoutType?

Accessors

Constructors

constructor

new ApiError<Body>(__namedParameters): ApiError<Body>
Type Parameters
- Body
Parameters
- __namedParameters: ApiErrorArgs
Returns ApiError<Body>
Overrides Error.constructor
- Defined in response.ts:31

Properties

`Readonly`body

body: Body

`Readonly`requestId

requestId: string

`Readonly`status

status: number

`Optional` `Readonly`timeoutType

timeoutType?: string

Accessors

isUserTimeout

get isUserTimeout(): boolean
Returns true if this error was caused by a user-specified timeout (via startTimeout parameter). These errors should NOT be retried.

Returns boolean
- Defined in response.ts:44