Class TypeCheckError

A type checking error.

Index

Constructors

Properties

actualValue expectedTypeName message path typeCheckedValue?

Methods

Constructors

constructor

new TypeCheckError(path, expectedTypeName, actualValue, typeCheckedValue?): TypeCheckError
Creates an instance of TypeError.
Parameters
- path: Path
  Sub-path (where the root is the value being type checked) where the error occured.
- expectedTypeName: string
  Name of the expected type.
- actualValue: any
  Actual value.
- OptionaltypeCheckedValue: any
  The value where the type check was invoked.
Returns TypeCheckError

Properties

`Readonly`actualValue

actualValue: any

Actual value.

`Readonly`expectedTypeName

expectedTypeName: string

Name of the expected type.

`Readonly`message

message: string

The type check error message.

`Readonly`path

path: Path

Sub-path (where the root is the value being type checked) where the error occured.

`Optional` `Readonly`typeCheckedValue

typeCheckedValue?: any

The value where the type check was invoked.

Methods

throw

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

Returns never