Class SpecMismatchException<S, HasKey, K, T>

An exception that can be thrown while generate-ing if the output does not match the expected Specs.

Type Parameters

Hierarchy

Constructors

constructor

Properties

actualValue cause? code expectedType key message meta? name specs stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

Properties

actualValue

actualValue: T

The actual value that was generated.

Optional cause

cause?: unknown

Readonly code

code: "specMismatch"

The code for the exception (one of GenerateExceptionTypes).

expectedType

expectedType: HasKey extends true
    ? SpecTypeNamesDict<MatchingOutput<S>>[Extract<keyof SpecTypeNamesDict<MatchingOutput<S>>, string>]
    : SpecTypeNamesSingle<MatchingOutput<S>>

The expected SpecTypeName.

key

key: K

The key of the Specs for which the mismatch occurred, if any.

message

message: string

Optional Readonly meta

meta?: any

Additional metadata for the exception.

name

name: string

specs

specs: S

The Specs that were expected.

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => 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

On This Page

Generated using TypeDoc