ConfiguardError

Defined in: src/ConfiguardError.ts:21

Error thrown by Configuard for any configuration fault — a corrupt config item, an invalid accessor, a failed ${...} template, an option-list violation, or a crypto-hook failure.

Consumers can check err instanceof ConfiguardError to treat configuration problems as the serious incidents they are. When the fault originates from a lower-level error (e.g. the value parser), it is attached as error.cause; the related config item key (when known) is available as error.key.

Extends

• Error

Constructor

new ConfiguardError(message?, options?): ConfiguardError

Defined in: src/ConfiguardError.ts:27

Parameters

message?

string = ''

options?

IConfiguardErrorOptions

Returns

ConfiguardError

Overrides

Error.constructor

Properties

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

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 = 'ConfiguardError'

Defined in: src/ConfiguardError.ts:22

Overrides

Error.name

---

key?

readonly optional key?: string

Defined in: src/ConfiguardError.ts:25

The config item key this error relates to, if available.

---

cause?

optional cause?: unknown

Defined in: site/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

message

message: string

Defined in: site/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

stack?

optional stack?: string

Defined in: site/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

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:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace