The error a bounded call rejects with. code is 'timeout' — the code R3-303's typed provider-error taxonomy adopts, so apps see one vocabulary.

Hierarchy

  • Error
    • ProtocolTimeoutError

Constructors

Properties

attendance: Attendance

Whether the call was on the attended or unattended bound — the first thing anyone debugging a timeout needs, and otherwise invisible.

WHICH bound elapsed (R3-307). An attended call that faults on its idle bound was not waiting on anyone — the host said so — and that is a genuinely different diagnosis from an abandoned prompt hitting the ceiling.

call: string

scheme:method of the call that timed out.

code: "timeout" = 'timeout'
message: string
name: string
stack?: string
timeoutMs: number

The bound that elapsed, in ms.

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
    • OptionalconstructorOpt: Function

    Returns void