Skip to main content

Class: ArtifactStoreError

Defined in: packages/artifact-store/src/errors.ts:36

Raised by an ArtifactStore. The message is fixed text naming what to do; it never carries the bytes, the credentials or a header value from the request. The SDK's error is kept as cause for the log.

Extends​

  • Error

Constructors​

Constructor​

new ArtifactStoreError(code, message, options?): ArtifactStoreError

Defined in: packages/artifact-store/src/errors.ts:53

Parameters​

code​

ArtifactStoreErrorCode

Why.

message​

string

A fixed explanation of what to do. Never a value from the request.

options?​

The underlying error, and whether a write's outcome is unknown.

cause?​

unknown

indeterminate?​

boolean

Returns​

ArtifactStoreError

Overrides​

Error.constructor

Properties​

cause?​

optional cause?: unknown

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

Inherited from​

Error.cause

code​

readonly code: ArtifactStoreErrorCode

Defined in: packages/artifact-store/src/errors.ts:39

The machine-readable reason.

indeterminate​

readonly indeterminate: boolean

Defined in: packages/artifact-store/src/errors.ts:46

True when a put failed in a way that leaves its outcome unknown: the request may have been stored even though no answer came back. Never collapse this into "not written". Retry with ifNoneMatch: '*' and read identical on exists; after a write fenced with ifMatch, get the key and compare the bytes instead.

message​

message: string

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

Inherited from​

Error.message

name​

readonly name: "ArtifactStoreError" = 'ArtifactStoreError'

Defined in: packages/artifact-store/src/errors.ts:37

Overrides​

Error.name

stack?​

optional stack?: string

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

Inherited from​

Error.stack

stackTraceLimit​

static stackTraceLimit: number

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

Accessors​

retryable​

Get Signature​

get retryable(): boolean

Defined in: packages/artifact-store/src/errors.ts:64

Whether the same call made later may succeed: unavailable and integrity_failed.

Returns​

boolean

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

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