firebase-js-sdk/docs-devsite/storage.storagereference.md

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

StorageReference interface

Represents a reference to a Google Cloud Storage object. Developers can upload, download, and delete objects, as well as get/set object metadata.

Signature:

export interface StorageReference 

Properties

Property	Type	Description
bucket	string	The name of the bucket containing this reference's object.
fullPath	string	The full path of this object.
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	StorageReference | null	A reference pointing to the parent location of this reference, or null if this reference is the root.
root	StorageReference	A reference to the root of this object's bucket.
storage	FirebaseStorage	The FirebaseStorage instance associated with this reference.

Methods

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

StorageReference.bucket

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

Signature:

bucket: string;

StorageReference.fullPath

The full path of this object.

Signature:

fullPath: string;

StorageReference.name

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'.

Signature:

name: string;

StorageReference.parent

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

Signature:

parent: StorageReference | null;

StorageReference.root

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

Signature:

root: StorageReference;

StorageReference.storage

The FirebaseStorage instance associated with this reference.

Signature:

storage: FirebaseStorage;

StorageReference.toString()

Returns a gs:// URL for this object in the form gs://<bucket>/<path>/<to>/<object>

Signature:

toString(): string;

Returns:

string

The gs:// URL.