Skip to main content
Version: 2

InvalidResponseBodyError

This error exists for the quite common situation, where only a partial JSON response is received and an attempt to parse the JSON throws an error. In most cases this can be resolved by retrying the request. We do that by identifying this error in HttpClient.

The properties mimic AxiosError for easier integration in HttpClient error handling.

Hierarchy

  • Error
    • InvalidResponseBodyError

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

cause

cause: Error

code

code: string

externalinheritedmessage

message: string

externalinheritedname

name: string

response

response: AxiosResponse<any, any, {}>

externaloptionalinheritedstack

stack?: 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