CubicleConnectionError

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

The Cubicle API could not be reached, or did not answer within the request timeout. code is connection_failed, request_timeout, or invalid_response for a successful response whose body is not JSON. cause holds the underlying error.

Extends

CubicleError

Constructors

Constructor

new CubicleConnectionError(
   code, 
   message, 
   options?
): CubicleConnectionError;

Parameters

Parameter	Type	Description
`code`	`string`	A stable machine-readable code, such as `not_found` or `wait_timeout`.
`message`	`string`	-
`options?`	{ `cause?`: `unknown`; }	-
`options.cause?`	`unknown`	-

Returns

CubicleConnectionError

Inherited from

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`.
`message`	`public`	`string`	-
`name`	`public`	`string`	Always `"CubicleConnectionError"`.
`stack?`	`public`	`string`	-

CubicleConnectionError

ExtendsCopy Anchor Link

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Inherited fromCopy Anchor Link

PropertiesCopy Anchor Link