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 %}

storage package

Cloud Storage for Firebase

Functions

Classes

Enumerations

Interfaces

Variables

Type Aliases

function(app, ...)

getStorage(app, bucketUrl) {:#getstorage_25f3a57}

Gets a FirebaseStorage instance for the given Firebase app.

<b>Signature:</b>

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

Parameters

<b>Returns:</b>

FirebaseStorage

A FirebaseStorage instance.

function(storage, ...)

connectStorageEmulator(storage, host, port, options) {:#connectstorageemulator_e9039de}

Modify this FirebaseStorage instance to communicate with the Cloud Storage emulator.

<b>Signature:</b>

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parameters

<b>Returns:</b>

void

ref(storage, url) {:#ref_5672fc1}

Returns a StorageReference for the given url.

<b>Signature:</b>

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

Parameters

<b>Returns:</b>

StorageReference

function(ref, ...)

deleteObject(ref) {:#deleteobject_30df0b2}

Deletes the object at this location.

<b>Signature:</b>

export declare function deleteObject(ref: StorageReference): Promise<void>;

Parameters

<b>Returns:</b>

Promise<void>

A Promise that resolves if the deletion succeeds.

getBlob(ref, maxDownloadSizeBytes) {:#getblob_1c7a935}

Downloads the data at the object's location. Returns an error if the object is not found.

To use this functionality, you have to whitelist your app's origin in your Cloud Storage bucket. See also https://cloud.google.com/storage/docs/configuring-cors

This API is not available in Node.

<b>Signature:</b>

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

Parameters

<b>Returns:</b>

Promise<Blob>

A Promise that resolves with a Blob containing the object's bytes

getBytes(ref, maxDownloadSizeBytes) {:#getbytes_1c7a935}

Downloads the data at the object's location. Returns an error if the object is not found.

To use this functionality, you have to whitelist your app's origin in your Cloud Storage bucket. See also https://cloud.google.com/storage/docs/configuring-cors

<b>Signature:</b>

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

Parameters

<b>Returns:</b>

Promise<ArrayBuffer>

A Promise containing the object's bytes

getDownloadURL(ref) {:#getdownloadurl_30df0b2}

Returns the download URL for the given StorageReference<!-- -->.

<b>Signature:</b>

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

Parameters

<b>Returns:</b>

Promise<string>

A Promise that resolves with the download URL for this object.

getMetadata(ref) {:#getmetadata_30df0b2}

A Promise that resolves with the metadata for this object. If this object doesn't exist or metadata cannot be retrieved, the promise is rejected.

<b>Signature:</b>

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

Parameters

<b>Returns:</b>

Promise<FullMetadata<!-- -->>

getStream(ref, maxDownloadSizeBytes) {:#getstream_1c7a935}

Downloads the data at the object's location. Raises an error event if the object is not found.

This API is only available in Node.

<b>Signature:</b>

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;

Parameters

<b>Returns:</b>

ReadableStream

A stream with the object's data as bytes

list(ref, options) {:#list_36af757}

List items (files) and prefixes (folders) under this storage reference.

List API is only available for Firebase Rules Version 2.

GCS is a key-blob store. Firebase Storage imposes the semantic of '/' delimited folder structure. Refer to GCS's List API if you want to learn more.

To adhere to Firebase Rules's Semantics, Firebase Storage does not support objects whose paths end with "/" or contain two consecutive "/"s. Firebase Storage List API will filter these unsupported objects. list() may fail if there are too many unsupported objects in the bucket.

<b>Signature:</b>

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

Parameters

<b>Returns:</b>

Promise<ListResult<!-- -->>

A Promise that resolves with the items and prefixes. prefixes contains references to sub-folders and items contains references to objects in this folder. nextPageToken can be used to get the rest of the results.

listAll(ref) {:#listall_30df0b2}

List all items (files) and prefixes (folders) under this storage reference.

This is a helper method for calling list() repeatedly until there are no more results. The default pagination size is 1000.

Note: The results may not be consistent if objects are changed while this operation is running.

Warning: listAll may potentially consume too many resources if there are too many results.

<b>Signature:</b>

export declare function listAll(ref: StorageReference): Promise<ListResult>;

Parameters

<b>Returns:</b>

Promise<ListResult<!-- -->>

A Promise that resolves with all the items and prefixes under the current storage reference. prefixes contains references to sub-directories and items contains references to objects in this folder. nextPageToken is never returned.

updateMetadata(ref, metadata) {:#updatemetadata_a634608}

Updates the metadata for this object.

<b>Signature:</b>

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

Parameters

<b>Returns:</b>

Promise<FullMetadata<!-- -->>

A Promise that resolves with the new metadata for this object.

uploadBytes(ref, data, metadata) {:#uploadbytes_02686b1}

Uploads data to this object's location. The upload is not resumable.

<b>Signature:</b>

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

Parameters

<b>Returns:</b>

Promise<UploadResult<!-- -->>

A Promise containing an UploadResult

uploadBytesResumable(ref, data, metadata) {:#uploadbytesresumable_02686b1}

Uploads data to this object's location. The upload can be paused and resumed, and exposes progress updates.

<b>Signature:</b>

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

Parameters

<b>Returns:</b>

UploadTask

An UploadTask

uploadString(ref, value, format, metadata) {:#uploadstring_277829d}

Uploads a string to this object's location. The upload is not resumable.

<b>Signature:</b>

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

Parameters

<b>Returns:</b>

Promise<UploadResult<!-- -->>

A Promise containing an UploadResult

function(storageOrRef, ...)

ref(storageOrRef, path) {:#ref_41be95d}

Returns a StorageReference for the given path in the default bucket.

<b>Signature:</b>

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

Parameters

<b>Returns:</b>

StorageReference

StringFormat

An enumeration of the possible string formats for upload.

<b>Signature:</b>

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

StringFormat

An enumeration of the possible string formats for upload.

<b>Signature:</b>

export type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

TaskEvent

An event that is triggered on a task.

<b>Signature:</b>

export type TaskEvent = 'state_changed';

TaskState

Represents the current state of a running upload.

<b>Signature:</b>

export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

StorageErrorCode

Error codes that can be attached to StorageError objects.

<b>Signature:</b>

export declare enum StorageErrorCode 

Enumeration Members