Creates a structured service error.
Outer gRPC status code.
Stable Dex-specific classification.
Human-readable service detail.
Client operation that failed.
Target Flow ID, or undefined for service-wide calls.
Optionaloptions: DexServiceErrorOptionsStandard Error construction options, plus an optional message that defaults
to detail.
OptionalcauseReadonlycodeOuter gRPC status code.
ReadonlydetailHuman-readable service detail.
ReadonlyflowTarget Flow ID, or undefined for service-wide calls.
ReadonlyoperationClient operation that failed.
OptionalstackReadonlysubStable Dex-specific classification.
StaticstackThe 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.
StaticcaptureCreates 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();
OptionalconstructorOpt: FunctionStaticprepare
Reports a missing Flow or an operation that cannot use a closed Flow.
RPC calls use this error for missing targets, including query-only reads. A query-only RPC without locks, transactionality, durable effects, or Server-forced Update routing can read a retained terminal execution. At that confirmed read boundary, handle this error as not found without a lifecycle probe. Preserve other service and Worker failures.
Mutations and active-only RPCs also use this error for closed targets. It does not distinguish missing from closed Flows or prove the requested action succeeded. Inherited service metadata and the original transport cause remain available.
Example