Skip to main content

Class: OptionError

@sapphire/result.OptionError

Hierarchy

Constructors

constructor

new OptionError(message?)

Parameters

NameType
message?string

Inherited from

Error.constructor

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1073

new OptionError(message?, options?)

Parameters

NameType
message?string
options?ErrorOptions

Inherited from

Error.constructor

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:28

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1068


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1069


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

See

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

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Accessors

name

get name(): string

Returns

string

Overrides

Error.name

Defined in

projects/utilities/packages/result/src/lib/Option/OptionError.ts:2

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4