Class TypeCheckError

A type checking error.

Hierarchy

TypeCheckError

Index

Constructors

constructor

Properties

Methods

throw

Constructors

constructor

new TypeCheckError(path: Path, expectedTypeName: string, actualValue: any): TypeCheckError

- Defined in src/types/TypeCheckError.ts:16
Creates an instance of TypeError.

Parameters
- path: Path
  
  Sub-path where the error occured.
- expectedTypeName: string
  
  Name of the expected type.
- actualValue: any
  
  Actual value.
Returns TypeCheckError

Properties

Readonly actualValue

actualValue: any

Readonly expectedTypeName

expectedTypeName: string

Readonly path

path: Path

Methods

throw

throw(typeCheckedValue: any): never

- Defined in src/types/TypeCheckError.ts:23
Throws the type check error as an actual error.

Parameters
- typeCheckedValue: any
  
  Usually the value where the type check was invoked.
Returns never

Generated using TypeDoc