DomainValidationError

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

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

Extends

• DomainError

Constructors

Constructor

new DomainValidationError(message, status, body): DomainValidationError

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

Parameters

Parameter	Type
message	string
status	number
body	{[key: string]: any; }

Returns

DomainValidationError

Inherited from

DomainError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
body	readonly	object	-	DomainError.body	js-api/src/domains.ts:221
message	public	string	-	DomainError.message	docusaurus/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	DomainError.name	docusaurus/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?	public	string	-	DomainError.stack	docusaurus/node_modules/typescript/lib/lib.es5.d.ts:1078
status	readonly	number	-	DomainError.status	js-api/src/domains.ts:220
stackTraceLimit	static	number	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.	DomainError.stackTraceLimit	js-api/node_modules/@types/node/globals.d.ts:68

Accessors

code

Get Signature

get code(): string

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

Server discriminant: 'validation' | 'version-conflict' | 'restrict' | 'filter' | 'forbidden' | 'not-found' | 'manifest-validation' | 'invalid-mode' | 'id-collision' | 'destructive-confirmation-required' | schema-mgmt codes | '' (transport).

Returns

string

Inherited from

DomainError.code

---

isDuplicate

Get Signature

get isDuplicate(): boolean

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

True when the failure is a business-key/idempotency uniqueness conflict (per-row error code 'unique' — how the server reports duplicates under errorOnDuplicate).

Returns

boolean

---

opIndex

Get Signature

get opIndex(): number | undefined

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

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

Returns

number | undefined

Inherited from

DomainError.opIndex

---

rows

Get Signature

get rows(): DomainRowErrors[]

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

Returns

DomainRowErrors[]

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: js-api/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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

DomainError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: js-api/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

DomainError.prepareStackTrace