Class TypeCheckError

constructor

• new TypeCheckError(
      path: Path,
      expectedTypeName: string,
      actualValue: any,
      typeCheckedValue?: any,
  ): 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

ReadonlyactualValue

ReadonlyexpectedTypeName

Readonlymessage

Readonlypath

Optional ReadonlytypeCheckedValue

throw

• throw(): never

  Throws the type check error as an actual error.

  Returns never