IdempotencyCompletionError

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:26

Raised when the business handler succeeded but the idempotency record could not be finalized.

Retrying the request may repeat business side effects even though the caller received an error. Consumers can use executionSucceeded to distinguish this state from a handler failure and make an explicit retry/reconciliation decision, and phase to tell an unusable response apart from an unavailable store.

In both phases the claim is deliberately retained until its TTL expires. The side effects have already happened, so releasing the key would let the very next retry repeat them immediately. Retention does not prevent all duplicates — it only prevents immediate reentry while the claim is still live.

Extends

• Error

Constructors

Constructor

new IdempotencyCompletionError(key, claimId, cause, phase?): IdempotencyCompletionError

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:30

Parameters

key

string

claimId

string

cause

unknown

phase?

IdempotencyFinalizationPhase = 'store'

Returns

IdempotencyCompletionError

Overrides

Error.constructor

Properties

cause

readonly cause: unknown

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:33

Inherited from

Error.cause

---

claimId

readonly claimId: string

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:32

---

executionSucceeded

readonly executionSucceeded: true

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:28

---

key

readonly key: string

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:31

---

message

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

readonly name: "IdempotencyCompletionError" = 'IdempotencyCompletionError'

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:27

Overrides

Error.name

---

phase

readonly phase: IdempotencyFinalizationPhase = 'store'

Defined in: packages/pipeline-idempotency/src/errors/idempotency-completion.error.ts:34

---

stack?

optional stack?: string

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

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.6.4/node_modules/@types/node/globals.d.ts:67

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@26.6.4/node_modules/@types/node/globals.d.ts:51

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

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@26.6.4/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace