FilesUploadError

Defined in: libs/ccs-files-user-client/src/core/errors.ts:124

The bytes could not be moved to the store: a PUT that failed after its retries, a store refusal, a part without an ETag (the store’s CORS must expose it), or a part URL that could not be obtained. partNumber is the part to blame (1 for a single PUT, null when none is); cause is the underlying error (a FilesApiError built from the store’s answer, or the network error).

Extends

• Error

Extended by

• UploadCancelledError
• UploadFileMismatchError

Constructors

Constructor

new FilesUploadError(message, details): FilesUploadError

Defined in: libs/ccs-files-user-client/src/core/errors.ts:130

Parameters

message

string

details

partNumber

number | null

uploadId?

string | null

cause?

unknown

Returns

FilesUploadError

Overrides

Error.constructor

Properties

name

readonly name: string = 'FilesUploadError'

Defined in: libs/ccs-files-user-client/src/core/errors.ts:125

Overrides

Error.name

---

partNumber

readonly partNumber: number | null

Defined in: libs/ccs-files-user-client/src/core/errors.ts:126

---

uploadId

readonly uploadId: string | null

Defined in: libs/ccs-files-user-client/src/core/errors.ts:127

---

cause

readonly cause: unknown

Defined in: libs/ccs-files-user-client/src/core/errors.ts:128

Overrides

Error.cause

---

stackTraceLimit

static stackTraceLimit: number

Defined in: libs/ccs-files-user-client/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

---

message

message: string

Defined in: apps/docs/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

stack?

optional stack?: string

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

Inherited from

Error.stack

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: libs/ccs-files-user-client/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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: libs/ccs-files-user-client/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace