Skip to main content

Class: DuplicateStepKeyError

Defined in: packages/workflow-engine/src/core/steps.ts:420

Thrown when one stage invocation asks for the same step key twice.

Steps are keyed by name, not by ordinal position, which is what buys the refactoring tolerance an ordinal engine cannot offer: renaming or reordering surrounding code does not invalidate a run. The debt is that two steps sharing a key would silently answer each other's results — the second run would never execute and would return the first one's value with no error anywhere. The engine refuses rather than pay it.

This is a programming error, not a runtime fault: it is deterministic, so the stage is failed without consuming retry attempts.

Extends​

  • Error

Constructors​

Constructor​

new DuplicateStepKeyError(stepId, first, second): DuplicateStepKeyError

Defined in: packages/workflow-engine/src/core/steps.ts:426

Parameters​

stepId​

string

first​

StepKeyUse

second​

StepKeyUse

Returns​

DuplicateStepKeyError

Overrides​

Error.constructor

Properties​

[STEP_DUPLICATE_KEY]​

readonly [STEP_DUPLICATE_KEY]: true

Defined in: packages/workflow-engine/src/core/steps.ts:421

cause?​

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

Error.cause

first​

readonly first: StepKeyUse

Defined in: packages/workflow-engine/src/core/steps.ts:423

message​

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.name

second​

readonly second: StepKeyUse

Defined in: packages/workflow-engine/src/core/steps.ts:424

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

stepId​

readonly stepId: string

Defined in: packages/workflow-engine/src/core/steps.ts:422

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.19.7/node_modules/@types/node/globals.d.ts:68

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.

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.19.7/node_modules/@types/node/globals.d.ts:52

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

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

isError()​

static isError(error): error is Error

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters​

error​

unknown

Returns​

error is Error

Inherited from​

Error.isError

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@22.19.7/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

Error.prepareStackTrace