storage package

Stay organized with collections Save and categorize content based on your preferences.

Cloud Storage for Firebase

Functions

Classes

Enumerations

Interfaces

Variables

Type Aliases

function(app, ...)

getStorage(app, bucketUrl)

Gets a FirebaseStorage instance for the given Firebase app.

Signature:

exportdeclarefunctiongetStorage(app?:FirebaseApp,bucketUrl?:string):FirebaseStorage;

Parameters

Returns:

FirebaseStorage

A FirebaseStorage instance.

function(storage, ...)

connectStorageEmulator(storage, host, port, options)

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

Signature:

exportdeclarefunctionconnectStorageEmulator(storage:FirebaseStorage,host:string,port:number,options?:{mockUserToken?:EmulatorMockTokenOptions|string;}):void;

Parameters

Returns:

void

ref(storage, url)

Returns a StorageReference for the given url.

Signature:

exportdeclarefunctionref(storage:FirebaseStorage,url?:string):StorageReference;

Parameters

Returns:

StorageReference

function(ref, ...)

deleteObject(ref)

Deletes the object at this location.

Signature:

exportdeclarefunctiondeleteObject(ref:StorageReference):Promise<void>;

Parameters

Returns:

Promise<void>

A Promise that resolves if the deletion succeeds.

getBlob(ref, maxDownloadSizeBytes)

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.

Signature:

exportdeclarefunctiongetBlob(ref:StorageReference,maxDownloadSizeBytes?:number):Promise<Blob>;

Parameters

Returns:

Promise<Blob>

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

getBytes(ref, maxDownloadSizeBytes)

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

Signature:

exportdeclarefunctiongetBytes(ref:StorageReference,maxDownloadSizeBytes?:number):Promise<ArrayBuffer>;

Parameters

Returns:

Promise<ArrayBuffer>

A Promise containing the object's bytes

getDownloadURL(ref)

Returns the download URL for the given StorageReference.

Signature:

exportdeclarefunctiongetDownloadURL(ref:StorageReference):Promise<string>;

Parameters

Returns:

Promise<string>

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

getMetadata(ref)

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.

Signature:

exportdeclarefunctiongetMetadata(ref:StorageReference):Promise<FullMetadata>;

Parameters

Returns:

Promise<FullMetadata>

getStream(ref, maxDownloadSizeBytes)

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.

Signature:

exportdeclarefunctiongetStream(ref:StorageReference,maxDownloadSizeBytes?:number):ReadableStream;

Parameters

Returns:

ReadableStream

A stream with the object's data as bytes

list(ref, options)

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.

Signature:

exportdeclarefunctionlist(ref:StorageReference,options?:ListOptions):Promise<ListResult>;

Parameters

Returns:

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)

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.

Signature:

exportdeclarefunctionlistAll(ref:StorageReference):Promise<ListResult>;

Parameters

Returns:

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)

Updates the metadata for this object.

Signature:

exportdeclarefunctionupdateMetadata(ref:StorageReference,metadata:SettableMetadata):Promise<FullMetadata>;

Parameters

Returns:

Promise<FullMetadata>

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

uploadBytes(ref, data, metadata)

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

Signature:

exportdeclarefunctionuploadBytes(ref:StorageReference,data:Blob|Uint8Array|ArrayBuffer,metadata?:UploadMetadata):Promise<UploadResult>;

Parameters

Returns:

Promise<UploadResult>

A Promise containing an UploadResult

uploadBytesResumable(ref, data, metadata)

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

Signature:

exportdeclarefunctionuploadBytesResumable(ref:StorageReference,data:Blob|Uint8Array|ArrayBuffer,metadata?:UploadMetadata):UploadTask;

Parameters

Returns:

UploadTask

An UploadTask

uploadString(ref, value, format, metadata)

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

Signature:

exportdeclarefunctionuploadString(ref:StorageReference,value:string,format?:StringFormat,metadata?:UploadMetadata):Promise<UploadResult>;

Parameters

Returns:

Promise<UploadResult>

A Promise containing an UploadResult

function(storageOrRef, ...)

ref(storageOrRef, path)

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

Signature:

exportdeclarefunctionref(storageOrRef:FirebaseStorage|StorageReference,path?:string):StorageReference;

Parameters

Returns:

StorageReference

StringFormat

An enumeration of the possible string formats for upload.

Signature:

StringFormat:{readonlyRAW:"raw";readonlyBASE64:"base64";readonlyBASE64URL:"base64url";readonlyDATA_URL:"data_url";}

StringFormat

An enumeration of the possible string formats for upload.

Signature:

exporttypeStringFormat=(typeofStringFormat)[keyoftypeofStringFormat];

TaskEvent

An event that is triggered on a task.

Signature:

exporttypeTaskEvent='state_changed';

TaskState

Represents the current state of a running upload.

Signature:

exporttypeTaskState='running'|'paused'|'success'|'canceled'|'error';

StorageErrorCode

Error codes that can be attached to StorageError objects.

Signature:

exportdeclareenumStorageErrorCode

Enumeration Members