Class: ArtifactIntegrityError

A stored payload no longer matches the digest minted with it. Thrown by get instead of returning the bytes — corrupt data delivered as whole data is the accepted-and-silently-wrong failure, and the one thing a claim check must never do is honor a ticket with someone else's parcel.

Extends

Error

Constructors

Constructor

new ArtifactIntegrityError(ref, expected, actual): ArtifactIntegrityError

Defined in: src/artifacts/types.ts:316

Parameters

ref

string

expected

string

actual

string

Returns

ArtifactIntegrityError

Overrides

Error.constructor

Properties

actual

readonly actual: string

Defined in: src/artifacts/types.ts:314

The digest of what the store actually holds now.

cause?

optional cause?: unknown

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

Inherited from

Error.cause

code

readonly code: "ERR_ARTIFACT_INTEGRITY"

Defined in: src/artifacts/types.ts:309

expected

readonly expected: string

Defined in: src/artifacts/types.ts:312

The digest minted at put.

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

ref

readonly ref: string

Defined in: src/artifacts/types.ts:310

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: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

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: 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();

static prepareStackTrace(err, stackTraces): any

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

ArtifactIntegrityError

On this page