Class LocalizedError

An error that has some localized information attached to it.

This error has extra meta data associated with the error that can be translated into different locales.

Hierarchy

  • Error
    • LocalizedError

Constructors

constructor

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Accessors

args index lex

Methods

captureStackTrace

Constructors

constructor

  • new LocalizedError(
        __namedParameters: {
            args?: Record<string, string | number>;
            index?: number;
            lex: string;
            message: string;
        },
    ): LocalizedError

  • Constructs a new parse error.

    Parameters

    • __namedParameters: {
          args?: Record<string, string | number>;
          index?: number;
          lex: string;
          message: string;
      }

    Returns LocalizedError

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Accessors

args

  • get args(): Record<string, string | number>

  • Returns Record<string, string | number>

    The arguments associated with the lexicon key to create a localized error message.

index

  • get index(): undefined | number

  • Returns undefined | number

    The index number of the character from the input originally associated with the error. Please note, this may return undefined if no line number was originally associated with the error.

lex

  • get lex(): string

  • Returns string

    The lexicon key associated with the error. If the looked up lexicon key has '%s', these will be replaced by arguments from in args.

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods