Class InvalidTypeError

The InvalidTypeError is thrown when a value associated with a key is not of the expected type.

This error helps enforce type safety in parsers by signaling when the actual type of a value differs from the expected type.

Example

throw new Parser.InvalidTypeError("age", "number", typeof value);
// Error: Key "age" expected number but got string

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new InvalidTypeError(
        key: string,
        expected: string,
        actual: string,
    ): InvalidTypeError

    Constructs a new InvalidTypeError with the specified key, expected type, and actual type.

    Parameters

    • key: string

      The name of the key with the invalid type.

    • expected: string

      The expected type of the value.

    • actual: string

      The actual type of the value.

    Returns InvalidTypeError

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string = "ParserInvalidTypeError"

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

Methods

StaticcaptureStackTrace

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

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

  • 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
Methods