UploadCancelledError

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

done of a cancelled upload rejects with this. code is 'upload_cancelled'.

Extends

• FilesUploadError

Constructors

Constructor

new UploadCancelledError(uploadId?): UploadCancelledError

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

Parameters

uploadId?

string | null = null

Returns

UploadCancelledError

Overrides

FilesUploadError.constructor

Properties

partNumber

readonly partNumber: number | null

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

Inherited from

FilesUploadError.partNumber

---

uploadId

readonly uploadId: string | null

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

Inherited from

FilesUploadError.uploadId

---

cause

readonly cause: unknown

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

Inherited from

FilesUploadError.cause

---

name

readonly name: "UploadCancelledError" = 'UploadCancelledError'

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

Overrides

FilesUploadError.name

---

code

readonly code: "upload_cancelled" = 'upload_cancelled'

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

---

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

FilesUploadError.stackTraceLimit

---

message

message: string

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

Inherited from

FilesUploadError.message

---

stack?

optional stack?: string

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

Inherited from

FilesUploadError.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

FilesUploadError.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

FilesUploadError.prepareStackTrace