Dex TypeScript SDK 1.29.0
    Preparing search index...

    Class FlowClosingError

    Reports a request rejected while Dex closes a Flow. Re-read the retained terminal Flow state before deciding what to do next.

    const options = { requestTimeoutMs: timeoutMs };
    try {
      await client.waitForStepCompletion(flowId, stepExecutionId, options);
    } catch (error) {
      if (error instanceof FlowClosingError) {
        await client.waitForFlow(flowId);
      } else {
        throw error;
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cause? code detail flowId message name operation stack? subStatus stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Creates a structured service error.

      Parameters

      • code: Status

        Outer gRPC status code.

      • subStatus: ErrorSubStatus

        Stable Dex-specific classification.

      • detail: string

        Human-readable service detail.

      • operation: string

        Client operation that failed.

      • flowId: string | undefined

        Target Flow ID, or undefined for service-wide calls.

      • Optionaloptions: DexServiceErrorOptions

        Standard Error construction options, plus an optional message that defaults to detail.

      Returns FlowClosingError

    Properties

    cause?: unknown
    code: Status

    Outer gRPC status code.

    detail: string

    Human-readable service detail.

    flowId: string | undefined

    Target Flow ID, or undefined for service-wide calls.

    message: string
    name: string
    operation: string

    Client operation that failed.

    stack?: string
    subStatus: ErrorSubStatus

    Stable Dex-specific classification.

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods