Class TypeCheckError

constructor

• new TypeCheckError(
      ...args:
          | [data: TypeCheckErrorData]
          | [
              path: Path,
              expectedTypeName: string,
              actualValue: any,
              typeCheckedValue?: any,
          ],
  ): TypeCheckError

  Creates a type check error from an object payload. Prefer the object form; the positional form is kept for backwards compatibility.

  Parameters

  • ...args:
        | [data: TypeCheckErrorData]
        | [
            path: Path,
            expectedTypeName: string,
            actualValue: any,
            typeCheckedValue?: any,
        ]

  Returns TypeCheckError

ReadonlyactualValue

ReadonlyexpectedTypeName

Readonlymessage

Optional ReadonlymodelTrail

Readonlypath

Optional ReadonlytypeCheckedValue

throw

• throw(): never

  Throws the type check error as an actual error.

  Returns never