voluptasmollitia

Version:

Monorepo for the Firebase JavaScript SDK

58 lines (45 loc) • 4.77 kB

Markdown

[Home](./index.md) > [@firebase/storage](./storage.md) ## storage package Cloud Storage for Firebase ## Functions | Function | Description | | --- | --- | | [deleteObject(ref)](./storage.deleteobject.md) | Deletes the object at this location. | | [getDownloadURL(ref)](./storage.getdownloadurl.md) | Returns the download URL for the given Reference. | | [getMetadata(ref)](./storage.getmetadata.md) | A promise that resolves with the metadata for this object. If this object doesn't exist or metadata cannot be retreived, the promise is rejected. | | [getStorage(app, bucketUrl)](./storage.getstorage.md) | Gets a Firebase StorageService instance for the given Firebase app. | | [list(ref, options)](./storage.list.md) | 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. | | [listAll(ref)](./storage.listall.md) | 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. | | [ref(storage, url)](./storage.ref.md) | Returns a StorageReference for the given url. | | [ref(storageOrRef, path)](./storage.ref_1.md) | Returns a StorageReference for the given path in the default bucket. | | [updateMetadata(ref, metadata)](./storage.updatemetadata.md) | Updates the metadata for this object. | | [uploadBytes(ref, data, metadata)](./storage.uploadbytes.md) | Uploads data to this object's location. The upload is not resumable. | | [uploadBytesResumable(ref, data, metadata)](./storage.uploadbytesresumable.md) | Uploads data to this object's location. The upload can be paused and resumed, and exposes progress updates. | | [uploadString(ref, value, format, metadata)](./storage.uploadstring.md) | Uploads a string to this object's location. The upload is not resumable. | | [useStorageEmulator(storage, host, port)](./storage.usestorageemulator.md) | Modify this <code>StorageService</code> instance to communicate with the Cloud Storage emulator. | ## Interfaces | Interface | Description | | --- | --- | | [FirebaseStorageError](./storage.firebasestorageerror.md) | An error returned by the Firebase Storage SDK. | | [FullMetadata](./storage.fullmetadata.md) | The full set of object metadata, including read-only properties. | | [ListOptions](./storage.listoptions.md) | The options <code>list()</code> accepts. | | [ListResult](./storage.listresult.md) | Result returned by list(). | | [SettableMetadata](./storage.settablemetadata.md) | Object metadata that can be set at any time. | | [StorageObserver](./storage.storageobserver.md) | A stream observer for Firebase Storage. | | [StorageReference](./storage.storagereference.md) | Represents a reference to a Google Cloud Storage object. Developers can upload, download, and delete objects, as well as get/set object metadata. | | [StorageService](./storage.storageservice.md) | A Firebase Storage instance. | | [UploadMetadata](./storage.uploadmetadata.md) | Object metadata that can be set at upload. | | [UploadResult](./storage.uploadresult.md) | Result returned from a non-resumable upload. | | [UploadTask](./storage.uploadtask.md) | Represents the process of uploading an object. Allows you to monitor and manage the upload. | | [UploadTaskSnapshot](./storage.uploadtasksnapshot.md) | Holds data about the current state of the upload task. | ## Variables | Variable | Description | | --- | --- | | [StringFormat](./storage.stringformat.md) | An enumeration of the possible string formats for upload. | ## Type Aliases | Type Alias | Description | | --- | --- | | [StringFormat](./storage.stringformat.md) | An enumeration of the possible string formats for upload. | | [TaskEvent](./storage.taskevent.md) | An event that is triggered on a task. | | [TaskState](./storage.taskstate.md) | Represents the current state of a running upload. |