Skip to main content
Canonical SDK base error.

Extends

  • Error

Extended by

Constructors

Constructor

new ParmanaError(options): ParmanaError
Creates a ParmanaError.

Parameters

options
ParmanaErrorOptions

Returns

ParmanaError

Overrides

Error.constructor

Properties

code

readonly code: ErrorCode
Stable machine-readable error code.

requestId?

readonly optional requestId?: string
Optional request identifier.

cause?

readonly optional cause?: unknown
Optional underlying cause.

Overrides

Error.cause

statusCode?

readonly optional statusCode?: number
The HTTP status of the response this error was made from, for example 403 or 503. Absent when no response was received (a network error or a timeout) and for errors raised by the SDK itself. The Python SDK’s equivalent is status_code.

stackTraceLimit

static stackTraceLimit: number
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

name

name: string

Inherited from

Error.name

message

message: string

Inherited from

Error.message

stack?

optional stack?: string

Inherited from

Error.stack

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}. The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace. The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

Parameters

targetObject
object
constructorOpt?
Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

err
Error
stackTraces
CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace