npm package: @nativescript/firebase-storage
Description: NativeScript Firebase - Storage
Author: NativeScript
Latest version: 5.0.2

# @nativescript/firebase-storage

## Contents

- [Intro](#intro)
- [Set up and initialize Firebase for your app](#set-up-and-initialize-firebase-for-your-app)
- [Create a default Cloud Storage bucket](#create-a-default-cloud-storage-bucket)
- [Add the Firebase Cloud Storage SDK to your app](#add-the-firebase-cloud-storage-sdk-to-your-app)
- [Create a Firebase Storage instance](#create-a-firebase-storage-instance)
- [Creating a file reference](#creating-a-file-reference)
- [Upload a file](#upload-a-file)
- [Dealing with tasks](#dealing-with-tasks)
	- [Checking upload/download task progress](#checking-uploaddownload-task-progress)
	- [Pausing & resuming tasks](#pausing--resuming-tasks)
- [Generate a new download URL](#generate-a-new-download-url)
- [List files and directories in  bucket reference](#list-files-and-directories-in-bucket-reference)
- [Customizing security rules](#customizing-security-rules)
- [Switching storage buckets](#switching-storage-buckets)
- [API](#api)
	- [Storage class](#storage-class)
		- [android](#android)
		- [ios](#ios)
		- [app](#app)
		- [maxDownloadRetryTime](#maxdownloadretrytime)
		- [maxOperationRetryTime](#maxoperationretrytime)
		- [maxUploadRetryTime](#maxuploadretrytime)
		- [constructor()](#constructor)
		- [useEmulator()](#useemulator)
		- [ref()](#ref)
		- [refFromURL()](#reffromurl)
	- [Reference object](#reference-object)
		- [android](#android-1)
		- [ios](#ios-1)
		- [bucket](#bucket)
		- [fullPath](#fullpath)
		- [name](#name)
		- [parent](#parent)
		- [root](#root)
		- [storage](#storage)
		- [child()](#child)
		- [delete()](#delete)
		- [getDownloadURL()](#getdownloadurl)
		- [getMetadata()](#getmetadata)
		- [list()](#list)
		- [listAll()](#listall)
		- [put()](#put)
		- [putFile()](#putfile)
		- [putString()](#putstring)
		- [updateMetadata()](#updatemetadata)
		- [writeToFile()](#writetofile)
	- [Task object](#task-object)
		- [android](#android-2)
		- [ios](#ios-2)
		- [snapshot](#snapshot)
		- [on()](#on)
		- [pause()](#pause)
		- [resume()](#resume)
		- [cancel()](#cancel)
		


## Intro 

This plugin allows you to use the native Firebase SDKs for [Cloud Storage](https://firebase.google.com/docs/storage) in your Nativescript app.

[![image](https://img.youtube.com/vi/_tyjqozrEPY/hqdefault.jpg)](https://www.youtube.com/watch?v=_tyjqozrEPY)

## Set up and initialize Firebase for your app

To use Firebase Cloud Storage, you initialize Firebase first. To set up and initialize Firebase for your NativeScript app, follow the instructions on the documentation of the [@nativescript/firebase-core](../firebase-core/) plugin.

## Create a default Cloud Storage bucket

To create a default Cloud Storage bucket, follow the instructions at [Create a default Cloud Storage bucket](https://firebase.google.com/docs/storage/ios/start#create_a_default_storage_bucket).

## Add the Firebase Cloud Storage SDK to your app

To add the Cloud Storage SDK to your app, install and import the `@nativescript/firebase-storage` plugin.

1. Install the plugin by running the following command in the root directory of your project.

```cli
npm install @nativescript/firebase-storage
```

2. To add the Firestore SDK, import the `@nativescript/firebase-storage` plugin. You should import the plugin once in your app project and the ideal place to do that is the app bootstrapping file( `app.ts`, `main.ts`, etc).

## Create a Firebase Storage instance

To create a new Storage instance, call the instance getter, `storage()`, method on the FirebaseApp instance.:

```ts
import { firebase } from '@nativescript/firebase-core';

const storage = firebase().storage();
```

By default, this allows you to interact with Firebase Storage using the default Firebase App used whilst installing Firebase on your platform. However, if you'd like to use a secondary Firebase App, pass the secondary app instance when calling the `storage` method:

```ts
import { firebase } from '@nativescript/firebase-core';
import '@nativescript/firebase-storage';

// create secondary app instance
const config = new FirebaseOptions();
const secondaryApp = firebase.initializeApp(config, 'SECONDARY_APP');

const storage = firebase().storage(secondaryApp);
```

You can view your buckets on the [Firebase Console](https://console.firebase.google.com/project/_/storage/files).

### Creating a file reference

A reference is a local pointer to some file on your bucket. This can either be a file that already exists or one which does not exist yet. 

- To create a reference, call the [ref](#ref) method passing it the file name, with extension, on the [Storage](#storage-class) instance:

```ts
import { firebase } from '@nativescript/firebase-core';
import '@nativescript/firebase-storage';

const reference = firebase().storage().ref('black-t-shirt-sm.png');
```

- You can also specify a file located in a deeply nested directory:

```ts
import { firebase } from '@nativescript/firebase-core';
const reference = firebase().storage().ref('/images/t-shirts/black-t-shirt-sm.png');
```

### Upload a file

To upload a file directly from the user's device, follow these steps:

1. Create a reference to the file you want to upload.
```ts
import { firebase } from '@nativescript/firebase-core';

const reference = firebase().storage().ref('black-t-shirt-sm.png');
```

-2.  Get the path to the file on the users device. For example, 
```ts
import { knownfolders } from '@nativescript/core';

const pathToFile = knownFolders.documents().getFile('black-t-shirt-sm.png');
const filePath = pathToFile.path;
```
- Call the [putFile](#putfile) method on the reference, passing it the path to the local file.

```ts
await reference.putFile(filePath);
```

## Dealing with tasks

The [putFile](#putfile) method in the preceding example returns a [Task](#task-class) object, that allows you to hook into information such as the current upload progress.

### Checking upload/download task progress

To check the current task progress, you can listen to the `state_changed` event on the task:

```ts
const task = reference.putFile(pathToFile);

task.on('state_changed', (taskSnapshot) => {
	console.log(`${taskSnapshot.bytesTransferred} transferred out of ${taskSnapshot.totalBytes}`);
});

task.then(() => {
	console.log('Image uploaded to the bucket!');
});
```

### Pausing & resuming tasks

A task also provides the ability to pause and resume ongoing operations.  To pause a task, call the [pause](#pause) method and to resume, call the [resume](#resume) method:

```ts
const task = reference.putFile(pathToFile);

task.pause();

// Sometime later...
task.resume();
```

## Generate a new download URL

A common use case for Cloud Storage is to use it as a global Content Delivery Network (CDN) for your images. When uploading files to a bucket, they are not automatically available for consumption via an HTTP URL. To generate a new Download URL, you need to call the `getDownloadURL` method on a reference:

```ts
import { firebase } from '@nativescript/firebase-core';

const url = firebase().storage().ref('images/profile-1.png').getDownloadURL();
```

## List files and directories in bucket reference

To view a full list of the current files & directories within a particular bucket reference, call [list](#list) on a [reference](#reference-object) instance. The results are paginated, and if more results are available you can pass a page token into the request:

```ts
import { firebase } from '@nativescript/firebase-core';

function listFilesAndDirectories(reference, pageToken) {
	return reference.list({ pageToken }).then((result) => {
		// Loop over each item
		result.items.forEach((ref) => {
			console.log(ref.fullPath);
		});

		if (result.nextPageToken) {
			return listFilesAndDirectories(reference, result.nextPageToken);
		}

		return Promise.resolve();
	});
}

const reference = firebase().storage().ref('images');

listFilesAndDirectories(reference).then(() => {
	console.log('Finished listing');
});
```

### Customizing security rules

By default your bucket will come with rules which allow only authenticated users on your project to access it. You can, however, fully customize the security rules to your application's requirements.

To learn more, see [Get started with Firebase Security Rules](https://firebase.google.com/docs/storage/security/get-started) documentation on the Firebase website.

### Switching storage buckets

A single Firebase project can have multiple storage buckets. The module will use the default bucket if no bucket argument is passed to the storage instance. To switch buckets, provide the module with the gs:// bucket URL found on the Firebase Console, under `Storage > Files`.

```ts
import { firebase, FirebaseOptions } from '@nativescript/firebase-core';
const defaultStorageBucket = firebase().storage();
const config = new FirebaseOptions();
config.storageBucket = 'gs://my-secondary-bucket.appspot.com';
const secondaryApp = firebase.app(config, 'SECONDARY_APP');
const secondaryStorageBucket = firebase().storage(secondaryApp);
```

## API

### Storage class
#### android
```ts
import { firebase } from '@nativescript/firebase-core';

storageAndroid: com.google.firebase.storage.FirebaseStorage = firebase().storage().android;
```
A `read-only` property that returns the underlying native Android object.

---
#### ios
```ts
import { firebase } from '@nativescript/firebase-core';

storageIOS: FIRStorage = firebase().storage().ios;
```
A `read-only` property that returns the underlying native iOS object.

---
#### app
```ts
import { firebase } from '@nativescript/firebase-core';

storageApp: FirebaseApp = firebase().storage().app;
```
A `read-only` property that returns the FirebaseApp instance to which this Storage belongs.

---
#### maxDownloadRetryTime
```ts
import { firebase } from '@nativescript/firebase-core';

maxDownloadRetryTime: number = firebase().storage().maxDownloadRetryTime;
// or

```
Returns or sets the maximum time, in milliseconds, to retry downloads in the case of a failure.

---
#### maxOperationRetryTime
```ts
import { firebase } from '@nativescript/firebase-core';

maxOperationRetryTime: number = firebase().storage().maxOperationRetryTime;
```
Returns or sets the maximum time, in milliseconds, to retry operations other than uploads or downloads in the case of a failure.

---
#### maxUploadRetryTime
```ts
import { firebase } from '@nativescript/firebase-core';

maxUploadRetryTime: number = firebase().storage().maxUploadRetryTime;
```
Gets or sets the maximum time, in milliseconds, to retry uploads in the case of a failure.

---
#### constructor()
```ts
import { firebase } from '@nativescript/firebase-core';

new Storage(app);
```

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `app` | `FirebaseApp` | _Optional_ : The FirebaseApp instance to which this Storage belongs. |

---
#### useEmulator()
```ts
import { firebase } from '@nativescript/firebase-core';

firebase().storage().useEmulator(host, port);
```
Attempts to connect to the Storage emulator running locally on the given host and port.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `host` | `string` | The emulator host. |
| `port` | `number` | The emulator port. |


---
#### ref()
```ts
import { firebase } from '@nativescript/firebase-core';

reference: Reference = firebase().storage().ref(path);
```
Creates a new storage [reference]() initialized at the root Firebase Storage location, if no path argument is provided, or at the given path if a path argument is provided.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `path` | `string` | _Optional_ : The path to initialize the reference at. |

---
#### refFromURL()
```ts
import { firebase } from '@nativescript/firebase-core';

reference: Reference = firebase().storage().refFromURL(url);
```
Creates a new storage [reference]() initialized from the specific URL.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `url` | `string` | The URL to initialize the reference from. |

---

### Reference object

#### android
```ts
referenceAndroid: com.google.firebase.storage.StorageReference = reference.android;
```

A `read-only` property that returns the underlying native StorageReference object for Android.

---
#### ios
```ts
referenceIOS: FIRStorageReference = reference.ios;
```
A `read-only` property that returns the underlying native StorageReference object for iOS.

---
#### bucket
```ts
bucket: string = reference.bucket;
```
A `read-only` property that returns the name of the bucket containing this reference's object.

---
#### fullPath
```ts
fullPath: string = reference.fullPath;
```

A `read-only` property that returns the full path to this object, not including the Google Cloud Storage bucket.

---
#### name
```ts
name: string = reference.name;
```
A `read-only` property that returns the short name of this object's path, which is the last component of the full path.

---
#### parent
```ts
parent: Reference = reference.parent;
```
A `read-only` property that returns a reference to the parent of the current reference, or null if the current reference is the root.

---
#### root
```ts
root: Reference = reference.root;
```
A `read-only` property that returns a reference to the root of the current reference's bucket.

---
#### storage
```ts
storage: Storage = reference.storage;
```
A `read-only` property that returns the [Storage](#storage-class) instance associated with the reference.

---
#### child()
```ts
reference: Reference = reference.child(path);
```
Returns a reference to a relative path from the current reference. For more information, see [child](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#child(java.lang.String)) on the Firebase website.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `path` | `string` | The child path. |

---
#### delete()
```ts
reference.delete();
```
Deletes the object at the current reference's location.

---
#### getDownloadURL()
```ts
downloadURL: string = await reference.getDownloadURL();
```
Asynchronously retrieves a long-lived download URL with a revokable token. For more information, see [getDownloadUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#getDownloadUrl()) on the Firebase website.

---
#### getMetadata()
```ts
metadata: Metadata = await reference.getMetadata();
```
Asynchronously retrieves metadata associated with an object at the current reference's location. For more information description about this method, see [getMetadata](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#getMetadata()) on the Firebase website.

You can find the properties of the Metadata object [here](https://github.com/NativeScript/firebase/blob/main/packages/firebase-storage/index.d.ts#L131-L157).

---
#### list()
```ts
listResult: ListResult = await reference.list(options);
```
Returns items (files) and prefixes (folders) under this StorageReference.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `options` | [ListOptions](#listoptions-interface) | _Optional_ : An object to configure the listing operation. The `ListOptions` properties are described in the [list](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#list(int,java.lang.String)) method on the Firebase docs.| 

#### ListOptions interface

```ts
interface ListOptions {
	maxResults: undefined | number;
	pageToken: undefined | string;
}
```

---
#### listAll()
```ts
listResult: ListResult = await reference.listAll();
```

Asynchronously returns a list of all items (files) and prefixes (folders) under this StorageReference. For more information, see [listAll](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#listAll()) on the Firebase website.

---
#### put()
```ts
task: Task = reference.put(data, metadata);
```
Uploads data to this reference's location. For more information, see [putBytes](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#putBytes(byte[],com.google.firebase.storage.StorageMetadata)) on the Firebase website.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `data` | `Blob \| Uint8Array \| ArrayBuffer` | The data to upload. |
| `metadata` | [Metadata](https://github.com/NativeScript/firebase/blob/main/packages/firebase-storage/index.d.ts#L131-L157) | _Optional_ : The metadata to associate with this upload. |


---
#### putString()
```ts
stringTask: Task = reference.putString(data, format, metadata);
```
Uploads bytes data from a string to this reference's location.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `data` | `string` | The base64 string to upload . |
| `format` | [StringFormat](#stringformat-enum) | The format of the string to upload. |
| `metadata` | [Metadata](https://github.com/NativeScript/firebase/blob/main/packages/firebase-storage/index.d.ts#L131-L157) | _Optional_ : The metadata to associate with this upload. |

#### StringFormat enum

```ts
enum StringFormat {
	RAW = 'raw',
	BASE64 = 'base64',
	BASE64URL = 'base64url',
	DATA_URL = 'data_url',
}
```

---
#### putFile()
```ts
fileTask: Task = reference.putFile(path, metadata);
```
Uploads a file to this reference's location.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `path` | `string` | The path to the file to upload. |
| `metadata` | [Metadata](https://github.com/NativeScript/firebase/blob/main/packages/firebase-storage/index.d.ts#L131-L157) | _Optional_ : The metadata to associate with this upload. |

---
#### updateMetadata()
```ts
updatedMetadata: FullMetadata = await reference.updateMetadata(metadata);
```
Updates the specified metadata associated with this reference. For more information, see [updateMetadata](https://firebase.google.com/docs/reference/android/com/google/firebase/storage/StorageReference#updateMetadata(com.google.firebase.storage.StorageMetadata)) on the Firebase website.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `metadata` | [Metadata](https://github.com/NativeScript/firebase/blob/main/packages/firebase-storage/index.d.ts#L131-L157) | The metadata to update. |

---
#### writeToFile()

```ts
fileWriteTask: Task = reference.writeToFile(localFilePath);
```
Downloads the object at this reference's location to the specified system file path. For more information, see [writeToFile](https://firebase.google.com/docs/reference/ios/firebasestorage/api/reference/Classes/FIRStorageReference#-writetofile:) on the Firebase website.

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `localFilePath` | `string` | The path to which the file should be downloaded. |

---

### Task object

#### android
```ts
taskAndroid: com.google.firebase.storage.FileDownloadTask.TaskSnapshot | com.google.firebase.storage.UploadTask.TaskSnapshot = task.android;
```
A `read-only` property that returns the native Android object.

---
#### ios
```ts
taskIOS: FIRStorageUploadTask | FIRStorageDownloadTask = task.ios;
```
A `read-only` property that returns the native iOS object.

---
#### snapshot
```ts
taskSnapshot: TaskSnapshot = task.snapshot;
```

---
#### on()
```ts
task.on(event, nextOrObserver, error, complete);
```

| Parameter | Type | Description |
| :--- | :--- | :--- |
| `event` | [TaskEvent](#taskevent-enum) | The event name. |
| `nextOrObserver` | `((a: TaskSnapshot) => any) \| TaskSnapshotObserver` | _Optional_ : The observer object or a function to be called on each event. |
| `error` | `(a: FirebaseError) => any` | _Optional_ : The function to be called on error. |
| `complete` | `() => void` | _Optional_ : The function to be called on completion. |

#### TaskEvent enum

```ts
enum TaskEvent {
	STATE_CHANGED = 'state_changed',
}
```

#### cancel()
```ts
cancelled: boolean = task.cancel();
```
Cancels the current upload or download task.

---
#### pause()
```ts
paused: boolean = task.pause();
```
Pauses the current upload or download task.


---
#### resume()
```ts
resumed: boolean = task.resume();
```
Resumes the current upload or download task.

---

## License

Apache License Version 2.0