Graphorin API reference v0.14.0

---

Graphorin API reference / @graphorin/store-sqlite-encrypted / / EncryptedBackupLiveWriterError

Class: EncryptedBackupLiveWriterError

Defined in: packages/store-sqlite-encrypted/src/backup.ts:46

Stable

Thrown when backupEncryptedDatabase detects another live holder of the source database (or a mutation racing the copy). Extends EncryptSwapLiveWriterError so existing catch sites for the live-writer guard keep working.

Extends

• EncryptSwapLiveWriterError

Constructors

Constructor

new EncryptedBackupLiveWriterError(sourcePath, cause?): EncryptedBackupLiveWriterError;

Defined in: packages/store-sqlite-encrypted/src/backup.ts:47

Parameters

Parameter	Type
sourcePath	string
cause?	unknown

Returns

EncryptedBackupLiveWriterError

Overrides

EncryptSwapLiveWriterError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	EncryptSwapLiveWriterError.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
message	public	string	-	EncryptSwapLiveWriterError.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	EncryptSwapLiveWriterError.name	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
sourcePath	readonly	string	-	EncryptSwapLiveWriterError.sourcePath	packages/store-sqlite-encrypted/src/encrypt.ts:108
stack?	public	string	-	EncryptSwapLiveWriterError.stack	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
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.	EncryptSwapLiveWriterError.stackTraceLimit	node_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:68

Methods

backupForSidecars()

static backupForSidecars(sourcePath, present): EncryptedBackupLiveWriterError;

Defined in: packages/store-sqlite-encrypted/src/backup.ts:57

Sidecar layer of the guard (mirrors the swap check).

Parameters

Parameter	Type
sourcePath	string
present	readonly string[]

Returns

EncryptedBackupLiveWriterError

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

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

EncryptSwapLiveWriterError.captureStackTrace

---

forConcurrentMutation()

static forConcurrentMutation(sourcePath): EncryptedBackupLiveWriterError;

Defined in: packages/store-sqlite-encrypted/src/backup.ts:71

The source mutated between the pre-copy and post-copy stats.

Parameters

Parameter	Type
sourcePath	string

Returns

EncryptedBackupLiveWriterError

---

forSidecars()

static forSidecars(sourcePath, present): EncryptSwapLiveWriterError;

Defined in: packages/store-sqlite-encrypted/src/encrypt.ts:117

deep-retest-0.13.10 P0: raised by the sidecar layer of the live-writer check. WAL sidecars are deleted when the LAST connection closes, so their presence means the database is open right now or the previous holder exited uncleanly - either way an in-place swap is unsafe.

Parameters

Parameter	Type
sourcePath	string
present	readonly string[]

Returns

EncryptSwapLiveWriterError

Inherited from

EncryptSwapLiveWriterError.forSidecars

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

EncryptSwapLiveWriterError.prepareStackTrace