Class TypeCheckError

A type checking error.

Index

Constructors

Properties

actualValue expectedTypeName message modelTrail? path typeCheckedValue?

Methods

Constructors

constructor

new TypeCheckError(data: TypeCheckErrorData): TypeCheckError
Creates a type check error from an object payload.
Parameters
- data: TypeCheckErrorData
  Type check error data.
Returns TypeCheckError
new TypeCheckError(
    path: Path,
    expectedTypeName: string,
    actualValue: any,
    typeCheckedValue?: any,
): TypeCheckError
Parameters
- path: Path
  Sub-path (where the root is the value being type checked) where the error occurred.
- expectedTypeName: string
  Name of the expected type.
- actualValue: any
  Actual value.
- OptionaltypeCheckedValue: any
  The value where the type check was invoked.
Returns TypeCheckError
Deprecated
Use the object payload constructor instead for better readability and maintainability.

Creates a type check error from positional parameters.

Properties

`Readonly`actualValue

actualValue: any

`Readonly`expectedTypeName

expectedTypeName: string

`Readonly`message

message: string

`Optional` `Readonly`modelTrail

modelTrail?: readonly string[]

`Readonly`path

path: Path

`Optional` `Readonly`typeCheckedValue

typeCheckedValue?: any

Methods

throw

throw(): never
Throws the type check error as an actual error.

Returns never