CubicleApiError

The CubicleApiError class of @cubicle/sdk: its constructor, properties and methods.

The Cubicle API answered with an error status. code is the API's error code, such as not_found, conflict or rate_limited, or http_<status> when the response carried none. Rate limits and transient failures were already retried when this is raised.

Extends

CubicleError

Constructors

Constructor

new CubicleApiError(
   status, 
   code, 
   message, 
   detail, 
   retryAfterSeconds
): CubicleApiError;

Parameters

Parameter	Type	Description
`status`	`number`	The HTTP status, such as 404 or 409.
`code`	`string`	-
`message`	`string`	-
`detail`	`Record`<`string`, `unknown`>	Extra fields from the API's error body.
`retryAfterSeconds`	`number` \| `undefined`	From `Retry-After`, for `rate_limited`, `blocked` and similar refusals.

Returns

CubicleApiError

Overrides

CubicleError.constructor

Properties

Property	Modifier	Type	Description
`cause?`	`public`	`unknown`	-
`code`	`readonly`	`string`	A stable machine-readable code, such as `not_found` or `wait_timeout`.
`detail`	`readonly`	`Record`<`string`, `unknown`>	Extra fields from the API's error body.
`message`	`public`	`string`	-
`name`	`public`	`string`	Always `"CubicleApiError"`.
`retryAfterSeconds`	`readonly`	`number` \| `undefined`	From `Retry-After`, for `rate_limited`, `blocked` and similar refusals.
`stack?`	`public`	`string`	-
`status`	`readonly`	`number`	The HTTP status, such as 404 or 409.

CubicleApiError

ExtendsCopy Anchor Link

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

PropertiesCopy Anchor Link