Class: OptionError

@sapphire/result.OptionError

Hierarchy

• Error

  ↳ OptionError

Constructors

constructor

• new OptionError(message?): OptionError

Parameters

Name	Type
message?	string

Returns

OptionError

Inherited from

Error.constructor

Defined in

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

• new OptionError(message?, options?): OptionError

Parameters

Name	Type
message?	string
options?	ErrorOptions

Returns

OptionError

Inherited from

Error.constructor

Defined in

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

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:1077

---

stack

• Optional stack: string

Inherited from

Error.stack

Defined in

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

---

prepareStackTrace

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

Optional override for formatting stack traces

See

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

Type declaration

▸ (err, stackTraces): any

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Defined in

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

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

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

Accessors

name

• get name(): string

Returns

string

Overrides

Error.name

Defined in

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

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

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