Class UnexpectedDataAPIResponseError

Overview

Error thrown when the Data API response is not as expected. Should never be thrown in normal operation.

Possible causes
  1. A Collection was used on a table, or vice versa.

  2. New Data API changes occurred that are not yet supported by the client.

  3. There is a bug in the Data API or the client.

Possible solutions

For #1, ensure that you're using the right Table or Collection class.

If #2 or #3, upgrade your client, and/or open an issue on the astra-db-ts GitHub repository.

  • If you open an issue, please include the full error message and any relevant context.
  • Please do not hesitate to do so, as there is likely a bug somewhere.

Hierarchy

  • Error
    • UnexpectedDataAPIResponseError

Constructors

Properties

message: string
name: string
rawDataAPIResponse?: unknown

The response that was unexpected.

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

  • 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

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • Type Parameters

    • T

    Parameters

    • val: undefined | null | T
    • message: string
    • Optional rawDataAPIResponse: unknown

    Returns T