Interface Reference

Represents a reference to a Google Cloud Storage object in React Native Firebase.

A reference can be used to upload and download storage objects, get/set storage object metadata, retrieve storage object download urls and delete storage objects.

Deprecated

Use the exported types directly instead. FirebaseStorageTypes namespace is kept for backwards compatibility.

Example 1

Get a reference to a specific storage path.

const ref = firebase.storage().ref('invertase/logo.png');

Example 2

Get a reference to a specific storage path on another bucket in the same firebase project.

const ref = firebase.storage().refFromURL('gs://other-bucket/invertase/logo.png');

interface Reference {
    bucket: string;
    fullPath: string;
    name: string;
    parent: FirebaseStorageTypes.Reference | null;
    root: FirebaseStorageTypes.Reference;
    storage: FirebaseStorageTypes.Module;
    child(path: string): FirebaseStorageTypes.Reference;
    delete(): Promise<void>;
    getDownloadURL(): Promise<string>;
    getMetadata(): Promise<FirebaseStorageTypes.FullMetadata>;
    list(
        options?: FirebaseStorageTypes.ListOptions,
    ): Promise<FirebaseStorageTypes.ListResult>;
    listAll(): Promise<FirebaseStorageTypes.ListResult>;
    put(
        data: Blob | ArrayBuffer | Uint8Array<ArrayBufferLike>,
        metadata?: FirebaseStorageTypes.UploadMetadata,
    ): FirebaseStorageTypes.Task;
    putFile(
        localFilePath: string,
        metadata?: FirebaseStorageTypes.UploadMetadata,
    ): FirebaseStorageTypes.Task;
    putString(
        data: string,
        format?: "raw" | "base64" | "base64url" | "data_url",
        metadata?: FirebaseStorageTypes.UploadMetadata,
    ): FirebaseStorageTypes.Task;
    toString(): string;
    updateMetadata(
        metadata: FirebaseStorageTypes.SettableMetadata,
    ): Promise<FirebaseStorageTypes.FullMetadata>;
    writeToFile(localFilePath: string): FirebaseStorageTypes.Task;
}

Index

Methods

child delete getDownloadURL getMetadata list listAll put putFile putString toString updateMetadata writeToFile

Properties

bucket fullPath name parent root storage

Methods

child

child(path: string): FirebaseStorageTypes.Reference
Returns a reference to a relative path from this reference.

Example
```
const parent = firebase.storage().ref('invertase');
const ref = parent.child('logo.png');
```
Parameters
- path: string
  The relative path from this reference. Leading, trailing, and consecutive slashes are removed.
Returns FirebaseStorageTypes.Reference
- Defined in storage/lib/types/namespaced.ts:548

delete

delete(): Promise<void>
Deletes the object at this reference's location.

Example
```
const ref = firebase.storage().ref('invertase/logo.png');
await ref.delete();
```
Returns Promise<void>
- Defined in storage/lib/types/namespaced.ts:560

getDownloadURL

getDownloadURL(): Promise<string>
Fetches a long lived download URL for this object.

Example
```
const ref = firebase.storage().ref('invertase/logo.png');
const url = await ref.getDownloadURL();
```
Returns Promise<string>
- Defined in storage/lib/types/namespaced.ts:572

getMetadata

getMetadata(): Promise<FirebaseStorageTypes.FullMetadata>
Fetches metadata for the object at this location, if one exists.

Example
```
const ref = firebase.storage().ref('invertase/logo.png');
const metadata = await ref.getMetadata();
console.log('Cache control: ', metadata.cacheControl);
```
Returns Promise<FirebaseStorageTypes.FullMetadata>
- Defined in storage/lib/types/namespaced.ts:585

list

list(
options?: FirebaseStorageTypes.ListOptions,
): Promise<FirebaseStorageTypes.ListResult>
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.

Example
```
const ref = firebase.storage().ref('/');
const results = await ref.list({
  maxResults: 30,
});
```
Parameters
- Optionaloptions: FirebaseStorageTypes.ListOptions
  An optional ListOptions interface.
Returns Promise<FirebaseStorageTypes.ListResult>
- Defined in storage/lib/types/namespaced.ts:610

listAll

listAll(): Promise<FirebaseStorageTypes.ListResult>
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.

Example
```
const ref = firebase.storage().ref('/');
const results = await ref.listAll();
```
Returns Promise<FirebaseStorageTypes.ListResult>
- Defined in storage/lib/types/namespaced.ts:628

put

put(
data: Blob | ArrayBuffer | Uint8Array<ArrayBufferLike>,
metadata?: FirebaseStorageTypes.UploadMetadata,
): FirebaseStorageTypes.Task
Puts data onto the storage bucket.

Example
```
const ref = firebase.storage().ref('invertase/new-logo.png');
const task = ref.put(BLOB, {
  cacheControl: 'no-store', // disable caching
});
```
Parameters
- data: Blob | ArrayBuffer | Uint8Array<ArrayBufferLike>
  The data to upload to the storage bucket at the reference location.
- Optionalmetadata: FirebaseStorageTypes.UploadMetadata
Returns FirebaseStorageTypes.Task
- Defined in storage/lib/types/namespaced.ts:679

putFile

putFile(
localFilePath: string,
metadata?: FirebaseStorageTypes.UploadMetadata,
): FirebaseStorageTypes.Task
Puts a file from local disk onto the storage bucket.

Example
```
const ref = firebase.storage().ref('invertase/new-logo.png');
const path = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/new-logo.png`;
const task = ref.putFile(path, {
  cacheControl: 'no-store', // disable caching
});
```
Parameters
- localFilePath: string
  The local file path to upload to the bucket at the reference location.
- Optionalmetadata: FirebaseStorageTypes.UploadMetadata
  Any additional UploadMetadata for this task.
Returns FirebaseStorageTypes.Task
- Defined in storage/lib/types/namespaced.ts:646

putString

putString(
    data: string,
    format?: "raw" | "base64" | "base64url" | "data_url",
    metadata?: FirebaseStorageTypes.UploadMetadata,
): FirebaseStorageTypes.Task
Puts a string on the storage bucket. Depending on the string type, set a StringFormat type.

Example
```
const ref = firebase.storage().ref('invertase/new-logo.png');
const task = ref.putString('PEZvbyBCYXI+', firebase.storage.StringFormat.BASE64, {
  cacheControl: 'no-store', // disable caching
});
```
Parameters
- data: string
  The string data, must match the format provided.
- Optionalformat: "raw" | "base64" | "base64url" | "data_url"
  The format type of the string, e.g. a Base64 format string.
- Optionalmetadata: FirebaseStorageTypes.UploadMetadata
  Any additional UploadMetadata for this task.
Returns FirebaseStorageTypes.Task
- Defined in storage/lib/types/namespaced.ts:697

toString

toString(): string
Returns a gs:// URL for this object in the form gs://<bucket>/<path>/<to>/<object>.

Example
```
const ref = firebase.storage().ref('invertase/logo.png');
console.log('Full path: ', ref.toString()); // gs://invertase.io/invertase/logo.png
```
Returns string
- Defined in storage/lib/types/namespaced.ts:534

updateMetadata

updateMetadata(
metadata: FirebaseStorageTypes.SettableMetadata,
): Promise<FirebaseStorageTypes.FullMetadata>
Updates the metadata for this reference object on the storage bucket.

Example
```
const ref = firebase.storage().ref('invertase/nsfw-logo.png');
const updatedMetadata = await ref.updateMetadata({
  customMetadata: {
    'nsfw': 'true',
  }
});
```
Parameters
- metadata: FirebaseStorageTypes.SettableMetadata
  A SettableMetadata instance to update.
Returns Promise<FirebaseStorageTypes.FullMetadata>
- Defined in storage/lib/types/namespaced.ts:719

writeToFile

writeToFile(localFilePath: string): FirebaseStorageTypes.Task
Downloads a file to the specified local file path on the device.

Example

Get a Download Storage task to download a file:
```
const downloadTo = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/foobar.json`;

const task = firebase.storage().ref('/foo/bar.json').writeToFile(downloadTo);
```
Parameters
- localFilePath: string
Returns FirebaseStorageTypes.Task
- Defined in storage/lib/types/namespaced.ts:662

Properties

bucket

bucket: string

The name of the bucket containing this reference's object.

fullPath

fullPath: string

The full path of this object.

name

name: string

The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'.

parent

parent: FirebaseStorageTypes.Reference | null

A reference pointing to the parent location of this reference, or null if this reference is the root.

root

root: FirebaseStorageTypes.Reference

A reference to the root of this reference's bucket.

storage

storage: FirebaseStorageTypes.Module

The storage service associated with this reference.

Interface Reference

Deprecated

Example 1

Example 2

Index

Methods

Properties

Methods

child

Example

Parameters

Returns FirebaseStorageTypes.Reference

delete

Example

Returns Promise<void>

getDownloadURL

Example

Returns Promise<string>

getMetadata

Example

Returns Promise<FirebaseStorageTypes.FullMetadata>

list

Example

Parameters

Returns Promise<FirebaseStorageTypes.ListResult>

listAll

Example

Returns Promise<FirebaseStorageTypes.ListResult>

put

Example

Parameters

Returns FirebaseStorageTypes.Task

putFile

Example

Parameters

Returns FirebaseStorageTypes.Task

putString

Example

Parameters

Returns FirebaseStorageTypes.Task

toString

Example

Returns string

updateMetadata

Example

Parameters

Returns Promise<FirebaseStorageTypes.FullMetadata>

writeToFile

Example

Parameters

Returns FirebaseStorageTypes.Task

Properties

bucket

fullPath

name

parent

root

storage

Settings

On This Page