CommitValidationError

Defined in: packages/rxdb-plugin-working-tree/src/commit/write-commit.ts:79

入参没过校验；在任何读写之前抛出。

Remarks

错误里只带 CommitValidationError.reason 与 CommitValidationError.kind， 不带任何入参值。调用方常见的日志写法会把错误对象整个序列化 （JSON.stringify(error, Object.getOwnPropertyNames(error))），带上 message / patch 就等于把加密列的明文抄进日志（FR-038）。

Extends

• RxDBError

Constructors

Constructor

new CommitValidationError(reason, kind): CommitValidationError;

Defined in: packages/rxdb-plugin-working-tree/src/commit/write-commit.ts:88

只由本文件的 assertValidCommitInput 构造，且早于任何读写。

Parameters

Parameter	Type	Description
reason	CommitValidationReason	可判别的拒绝原因
kind	CommitKind	出问题的提交类型；不含任何用户内容

Returns

CommitValidationError

Remarks

收的是「哪条约束」与「哪类提交」两个枚举，而不是违规的那个入参——这就是类注释那条 「不带任何入参值」在签名上的落点：两个参数的取值域都是有限字面量集合， 于是把整个错误对象序列化也带不出用户内容。

Overrides

RxDBError.constructor

Properties

cause?

optional cause?: unknown;

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

Inherited from

RxDBError.cause

---

kind

readonly kind: CommitKind;

Defined in: packages/rxdb-plugin-working-tree/src/commit/write-commit.ts:92

出问题的提交类型；不含任何用户内容

---

message

message: string;

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

Inherited from

RxDBError.message

---

name

name: string;

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

Inherited from

RxDBError.name

---

reason

readonly reason: CommitValidationReason;

Defined in: packages/rxdb-plugin-working-tree/src/commit/write-commit.ts:90

可判别的拒绝原因

---

stack?

optional stack?: string;

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

Inherited from

RxDBError.stack

---

stackTraceLimit

static stackTraceLimit: number;

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

RxDBError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

RxDBError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

RxDBError.prepareStackTrace