Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

StorageError class

An error returned by the Firebase Storage SDK.

Signature:

typescript

export declare class StorageError extends FirebaseError

Extends: FirebaseError

Constructors

Constructor	Modifiers	Description
(constructor)(code, message, status_)		Constructs a new instance of the <code>StorageError</code> class

Properties

Property	Type	Description
customData	{ serverResponse: string \| null; }	Stores custom error data unique to the <code>StorageError</code>.
serverResponse	null \| string	Optional response message that was added by the server.
status	number

Methods

Method	Modifiers	Description
_codeEquals(code)		Compares a <code>StorageErrorCode</code> against this error's code, filtering out the prefix.

StorageError.(constructor)

Constructs a new instance of the StorageError class

Signature:

typescript

constructor(code: StorageErrorCode, message: string, status_?: number);

Parameters

Parameter	Type	Description
code	StorageErrorCode	A <code>StorageErrorCode</code> string to be prefixed with 'storage/' and added to the end of the message.
message	string	Error message.
status_	number	Corresponding HTTP Status Code

StorageError.customData

Stores custom error data unique to the StorageError.

Signature:

typescript

customData: {
        serverResponse: string | null;
    };

StorageError.serverResponse

Optional response message that was added by the server.

Signature:

typescript

get serverResponse(): null | string;

set serverResponse(serverResponse: string | null);

StorageError.status

Signature:

typescript

get status(): number;

set status(status: number);

StorageError._codeEquals()

Compares a StorageErrorCode against this error's code, filtering out the prefix.

Signature:

typescript

_codeEquals(code: StorageErrorCode): boolean;

Parameters

Parameter	Type	Description
code	StorageErrorCode

Returns:

boolean