Class UcError

Charge error.

Represents an error info wrapped into Error.

Hierarchy

Error
- UcError

Implements

UcErrorInfo

Index

Constructors

Properties

prepareStackTrace? stackTraceLimit cause? message name stack?

Accessors

code details path

Methods

captureStackTrace create toJSON

Constructors

constructor

new UcError(info): UcError
Constructs error with the given info.
Parameters
- info: UcErrorInfo
  
  Error info.
Returns UcError
Overrides Error.constructor
- Defined in ucnot/churi/src/schema/uc-error.ts:51

Properties

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

`Optional` cause

cause?: unknown

Error cause. E.g. an exception thrown.

message

message: string

Default error message in English.

Default Value

'Unexpected error'

name

name: string

`Optional` stack

stack?: string

Accessors

code

get code(): string
Error code.

Returns string
Implementation of UcErrorInfo.code
- Defined in ucnot/churi/src/schema/uc-error.ts:62

details

get details(): Readonly<Record<string, unknown>>
Error details that can be used e.g. to build localized error message.

Returns Readonly<Record<string, unknown>>
Implementation of UcErrorInfo.details
- Defined in ucnot/churi/src/schema/uc-error.ts:70

path

get path(): URIChargePath
Path to the value containing the error.

Returns URIChargePath
Implementation of UcErrorInfo.path
- Defined in ucnot/churi/src/schema/uc-error.ts:66

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
  Optional
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@18.17.11/node_modules/@types/node/globals.d.ts:4

`Static` create

create(cause): UcError
Creates URI charge error caused by the given cause.
- If the given cause is UcError already, then just returns it.
- If the given cause is an error info, then wraps it into error.
- If the given cause is a string, then uses it as error message, with error code.
- If the given cause is an Error, the uses its message as error message, and Error instance as error cause with error cause.
- Otherwise, uses the cause as error cause with error code and default error message.
Parameters
- cause: unknown
  
  Cause of error.
Returns UcError
Error instance.
- Defined in ucnot/churi/src/schema/uc-error.ts:25

toJSON

toJSON(): UcErrorInfo
Returns UcErrorInfo
- Defined in ucnot/churi/src/schema/uc-error.ts:74

Generated using TypeDoc