Represents an error related to file operations.

This class extends ESPBaseError and uses labels to distinguish between file-not-found, file-upload, and file-download failures.

Hierarchy (View Summary)

Constructors

  • Creates an instance of ESPFileError.

    Parameters

    • label: ESPFileErrorLabel

      The label distinguishing not-found, upload, or download errors.

    • code: "FILE_NOT_FOUND" | "NO_DOWNLOAD_URL" | "S3_UPLOAD_FAILED" | "S3_DOWNLOAD_FAILED"

      The error code corresponding to a specific file error message from fileErrorMessages.

    • Optionaloptions: { body?: string; fileId?: string; status?: number }

      Optional contextual details for the error.

    Returns ESPFileError

Properties

body?: string

S3 REST error response body (typically XML) when the failure originated from a presigned URL request.

cause?: unknown
code: string

The specific error code associated with the error.

fileId?: string

The file id when the error is a not-found failure.

label: string

A label to classify the error type.

message: string
name: string
stack?: string
status?: number

HTTP status code when the failure originated from an S3 response.

stackTraceLimit: number

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.

Methods

  • 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
    • OptionalconstructorOpt: Function

    Returns void