breeze-client / QueuedSaveFailedError

Class: QueuedSaveFailedError

Defined in: src/mixins/mixin-save-queuing.ts:316

What every pending promise rejects with when a queued save fails.

One failure rejects the whole queue, because the saves behind it were built on the assumption that the one in front succeeded. Read QueuedSaveFailedError.innerError for what actually went wrong; the two memos are there for an application that wants to attempt a recovery, and are the mixin's internal bookkeeping rather than a documented shape.

Example

try {
  await em.saveChanges();
} catch (e) {
  if (e instanceof QueuedSaveFailedError) {
    console.error(e.innerError);
  }
}

Extends

• Error

Constructors

Constructor

new QueuedSaveFailedError(errObject, saveQueuing): QueuedSaveFailedError

Defined in: src/mixins/mixin-save-queuing.ts:331

Created by save queuing when a queued save fails; applications receive it rather than create it. errObject is the error the save failed with.

Parameters

errObject

Error

saveQueuing

any

Returns

QueuedSaveFailedError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

---

failedSaveMemo

failedSaveMemo: SaveMemo

Defined in: src/mixins/mixin-save-queuing.ts:325

The changes that were in the save that failed.

---

innerError

innerError: Error

Defined in: src/mixins/mixin-save-queuing.ts:321

The error the underlying save actually failed with.

---

message

message: string

Defined in: src/mixins/mixin-save-queuing.ts:323

"Queued save failed: " followed by QueuedSaveFailedError.innerError's message.

Overrides

Error.message

---

name

name: string = "QueuedSaveFailedError"

Defined in: src/mixins/mixin-save-queuing.ts:319

Always "QueuedSaveFailedError", so the error can be recognized by name as well as with instanceof.

Overrides

Error.name

---

nextSaveMemo

nextSaveMemo: SaveMemo

Defined in: src/mixins/mixin-save-queuing.ts:327

The changes queued up behind it, which were never sent.

---

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:68

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/@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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace