Class ConfigError

An error in the app configuration which exposes all details of originating ConfigElement or ConfigObjectElement.

Example

Throw an error using values from originating config element:

throw new ConfigError({
    ...configElement,
    reason: `The value must be 'Foo' or 'Bar' but it is 'WTF'`,
});

Hierarchy

  • Error
    • ConfigError

Constructors

constructor

Properties

filePath message name propertyPath reason stack? value prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • Example

    Creation from ConfigElement directly:

    throw new ConfigError({ ...element, reason: 'It is foo bar.' });

    Parameters

    • options: {
          filePath: string;
          propertyPath: string;
          reason: string;
          value: unknown;
      }
      • Readonly filePath: string
      • Readonly propertyPath: string
      • Readonly reason: string
      • Readonly value: unknown

    Returns ConfigError

Properties

Readonly filePath

filePath: string

message

message: string

name

name: string

Readonly propertyPath

propertyPath: string

Readonly reason

reason: string

Optional stack

stack?: string

Readonly value

value: unknown

Static Optional prepareStackTrace

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

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc