CubicleError

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

Base class for every error the SDK raises. An aborted signal rejects with its reason.

The SDK raises CubicleError itself, rather than a subclass, for configuration and client-side problems: missing_api_url, missing_api_key, invalid_option, org_required and missing_result.

See

Errors and retries

Extends

Error

Extended by

Constructors

Constructor

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

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

CubicleError

Overrides

Error.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 `"CubicleError"`.
`stack?`	`public`	`string`	-

SeeCopy Anchor Link

ExtendsCopy Anchor Link

Extended byCopy Anchor Link

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

PropertiesCopy Anchor Link

On this page

See