Errors

Errors raised by configuration, API, and command operations.

RuntaError

Base error for failures raised by the Runta SDK.

RuntaError declaration

class RuntaError extends Error

RuntaError construction

new RuntaError(message: string): RuntaError

Parameters

Name	Type	Default	Description
message	string	Required	Human-readable error message.

Returns

• RuntaError

ConfigError

Raised when required SDK configuration is missing or invalid.

ConfigError declaration

class ConfigError extends RuntaError

ConfigError construction

new ConfigError(message: string): ConfigError

Parameters

Name	Type	Default	Description
message	string	Required	Human-readable error message.

Returns

• ConfigError

ApiError

Raised when the Runta API returns an unsuccessful response.

ApiError declaration

class ApiError extends RuntaError

ApiError construction

new ApiError(message: string, options: { code?: string; statusCode?: number } = {}): ApiError

Parameters

Name	Type	Default	Description
message	string	Required	Human-readable error message.
options	{ code?: string; statusCode?: number }	{}	Options that control the operation.

Returns

• ApiError

ApiError properties

Name	Type	Description
code	string | undefined	Runta API error code, when available.
statusCode	number | undefined	HTTP status code, when available.

ApiError methods

toString()

Format the HTTP status, API code, and message.

ApiError.toString(): string

Returns

• string

CommandError

Raised when a runtime command fails under strict execution behavior.

CommandError declaration

class CommandError extends RuntaError

CommandError construction

new CommandError(message: string, options: { exitCode?: number } = {}): CommandError

Parameters

Name	Type	Default	Description
message	string	Required	Human-readable error message.
options	{ exitCode?: number }	{}	Options that control the operation.

Returns

• CommandError

CommandError properties

Name	Type	Description
exitCode	number | undefined	Command exit code, when available.