IdempotencyConflictError

Defined in: packages/pipeline-idempotency/src/errors/idempotency-conflict.error.ts:45

Thrown by IdempotencyBehavior when a request cannot be served:

• in_progress — an identical request is still running (409 Conflict);
• key_reuse — the key was already used with a different payload (422 Unprocessable Entity);
• replay_scope — the stored response was authorized under a different scope than the current caller’s, or the record predates scope capture (409 Conflict). The handler is not re-executed and the record is kept.

toHttpResponse of @cqrs-ddd/pipeline-idempotency/http maps it to its HTTP status.

Extends

• Error

Constructors

Constructor

new IdempotencyConflictError(params): IdempotencyConflictError

Defined in: packages/pipeline-idempotency/src/errors/idempotency-conflict.error.ts:58

Parameters

params

key

string

reason

IdempotencyConflictReason

requestName

string

Returns

IdempotencyConflictError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

key

readonly key: string

Defined in: packages/pipeline-idempotency/src/errors/idempotency-conflict.error.ts:47

The idempotency key in conflict.

---

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

name: string

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

Inherited from

Error.name

---

reason

readonly reason: IdempotencyConflictReason

Defined in: packages/pipeline-idempotency/src/errors/idempotency-conflict.error.ts:51

Why the request was rejected.

---

requestName

readonly requestName: string

Defined in: packages/pipeline-idempotency/src/errors/idempotency-conflict.error.ts:49

The request that was rejected, e.g. CreateUserCommand.

---

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

---

statusCode

readonly statusCode: number

Defined in: packages/pipeline-idempotency/src/errors/idempotency-conflict.error.ts:56

Suggested HTTP status: 409 for in_progress and replay_scope, 422 for key_reuse.

---

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