Skip to main content

DomainVersionConflictError

Defined in: js-api/src/domains.ts:1009

Base of all structured /domains failures; [body] is the server's error envelope.

Extends​

Constructors​

Constructor​

new DomainVersionConflictError(message, status, body): DomainVersionConflictError

Defined in: js-api/src/domains.ts:987

Parameters​

ParameterType
messagestring
statusnumber
body{[key: string]: any; }

Returns​

DomainVersionConflictError

Inherited from​

DomainError.constructor

Properties​

PropertyModifierTypeDescriptionInherited fromDefined in
bodyreadonlyobject-DomainError.bodyjs-api/src/domains.ts:988
cause?publicunknown-DomainError.causedocusaurus/node_modules/typescript/lib/lib.es2022.error.d.ts:26
messagepublicstring-DomainError.messagedocusaurus/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-DomainError.namedocusaurus/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-DomainError.stackdocusaurus/node_modules/typescript/lib/lib.es5.d.ts:1078
statusreadonlynumber-DomainError.statusjs-api/src/domains.ts:987
stackTraceLimitstaticnumberThe 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.DomainError.stackTraceLimitnode_modules/.pnpm/@types+node@22.20.2/node_modules/@types/node/globals.d.ts:68

Accessors​

code​

Get Signature​

get code(): string

Defined in: js-api/src/domains.ts:996

Server discriminant: 'validation' | 'version-conflict' | 'access-conflict' | 'restrict' | 'filter' | 'forbidden' | 'not-found' | 'unsupported' | 'manifest-validation' | 'invalid-mode' | 'id-collision' | 'destructive-confirmation-required' | 'not-user-managed' | 'not-package-managed' | 'schema-management-unavailable' | 'apply-failed' | 'delete-failed' | '' (transport).

Returns​

string

Inherited from​

DomainError.code


current​

Get Signature​

get current(): {[column: string]: unknown; } | undefined

Defined in: js-api/src/domains.ts:1027

The guard columns as the server read them AFTER refusing the write — a later observation, they may have moved again.

Returns​

{[column: string]: unknown; } | undefined


currentIncarnation​

Get Signature​

get currentIncarnation(): string | undefined

Defined in: js-api/src/domains.ts:1021

The schema's current incarnation, beside expectedIncarnation.

Returns​

string | undefined


currentVersion​

Get Signature​

get currentVersion(): string | number

Defined in: js-api/src/domains.ts:1013

The row's version as the server holds it; a schema apply's conflict carries the schema's apply counter, a string.

Returns​

string | number


expected​

Get Signature​

get expected(): {[column: string]: unknown; } | undefined

Defined in: js-api/src/domains.ts:1024

The old-value guard the write carried (DomainTransactionOp.expected), per column; undefined when the conflict is a version one.

Returns​

{[column: string]: unknown; } | undefined


expectedIncarnation​

Get Signature​

get expectedIncarnation(): string | undefined

Defined in: js-api/src/domains.ts:1019

The ifIncarnation a schema apply sent; present whenever the apply sent one, undefined on a row conflict. It differs from currentIncarnation only when the name was deleted and re-created since the edit was made.

Returns​

string | undefined


expectedVersion​

Get Signature​

get expectedVersion(): string | number

Defined in: js-api/src/domains.ts:1015

The version the write named.

Returns​

string | number


id​

Get Signature​

get id(): string

Defined in: js-api/src/domains.ts:1010

Returns​

string


opIndex​

Get Signature​

get opIndex(): number | undefined

Defined in: js-api/src/domains.ts:998

Index of the failing op in a transaction ops list; undefined otherwise.

Returns​

number | undefined

Inherited from​

DomainError.opIndex

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.20.2/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​

ParameterType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

DomainError.captureStackTrace


prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

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

Parameters​

ParameterType
errError
stackTracesCallSite[]

Returns​

any

See​

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

Inherited from​

DomainError.prepareStackTrace