Skip to main content
Version: Next

ResponseValidationError

Thrown when an API response does not match the schema the client expects for it.

The schemas are generated from the Apify OpenAPI specification, so this error means the API returned something the specification does not describe -- a missing required field, a different type, a value outside the documented range. Unknown fields and unknown enum values are not errors: the schemas let both through, so the client keeps working when the API grows.

The message names the request and every offending field with the value it received, and ends by asking for a bug report: the mismatch is in the API or its specification, not in the caller's code. The structured zod issues are available on issues, and the original ZodError on cause, for programmatic inspection.

Hierarchy

  • Error
    • ResponseValidationError

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • error: ZodError<unknown>
    • value: unknown
    • request: { method: string; url: string }
      • method: string
      • url: string

    Returns ResponseValidationError

Properties

externaloptionalinheritedcause

cause?: unknown

readonlyissues

issues: $ZodIssue[]

Structured issues from the underlying schema check.

externalinheritedmessage

message: string

readonlymethod

method: string

HTTP method of the request whose response failed validation, upper-cased.

externalinheritedname

name: string

externaloptionalinheritedstack

stack?: string

readonlyurl

url: string

URL of the request whose response failed validation, without its query string.

staticexternalinheritedstackTraceLimit

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Methods

staticexternalinheritedcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt): void

  • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

    const myObject = {};
    Error.captureStackTrace(myObject);
    myObject.stack;  // Similar to `new Error().stack`

    The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

    The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

    The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

    function a() {
      b();
    }

    function b() {
      c();
    }

    function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
    }

    a();

    Parameters

    • externaltargetObject: object
    • externaloptionalconstructorOpt: Function

    Returns void

staticexternalinheritedprepareStackTrace

  • prepareStackTrace(err, stackTraces): any
Page Options