react-native-firebase-compiled/dist/modules/storage/reference.js.flow

A well tested, feature rich Firebase implementation for React Native, supporting iOS & Android. Individual module support for Admob, Analytics, Auth, Crash Reporting, Cloud Firestore, Database, Dynamic Links, Functions, Messaging (FCM), Remote Config, Sto

/**
 * @flow
 * StorageReference representation wrapper
 */
import ReferenceBase from '../../utils/ReferenceBase';
import StorageTask, { UPLOAD_TASK, DOWNLOAD_TASK } from './task';
import { getNativeModule } from '../../utils/native';
import type Storage from '.';

/**
 * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference
 */
export default class StorageReference extends ReferenceBase {
  _storage: Storage;

  constructor(storage: Storage, path: string) {
    super(path);
    this._storage = storage;
  }

  get fullPath(): string {
    return this.path;
  }

  toString(): string {
    return `gs://${this._storage.app.options.storageBucket}${this.path}`;
  }

  /**
   * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#child
   * @param path
   * @returns {StorageReference}
   */
  child(path: string): StorageReference {
    return new StorageReference(this._storage, `${this.path}/${path}`);
  }

  /**
   * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#delete
   * @returns {Promise.<T>|*}
   */
  delete(): Promise<void> {
    return getNativeModule(this._storage).delete(this.path);
  }

  /**
   * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#getDownloadURL
   * @returns {Promise.<T>|*}
   */
  getDownloadURL(): Promise<string> {
    return getNativeModule(this._storage).getDownloadURL(this.path);
  }

  /**
   * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#getMetadata
   * @returns {Promise.<T>|*}
   */
  getMetadata(): Promise<Object> {
    return getNativeModule(this._storage).getMetadata(this.path);
  }

  /**
   * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#updateMetadata
   * @param metadata
   * @returns {Promise.<T>|*}
   */
  updateMetadata(metadata: Object = {}): Promise<Object> {
    return getNativeModule(this._storage).updateMetadata(this.path, metadata);
  }

  /**
   * Downloads a reference to the device
   * @param {String} filePath Where to store the file
   * @return {Promise}
   */
  downloadFile(filePath: string): StorageTask {
    return new StorageTask(
      DOWNLOAD_TASK,
      getNativeModule(this._storage).downloadFile(this.path, filePath),
      this
    );
  }

  /**
   * Alias to putFile
   * @returns {StorageReference.putFile}
   */
  get put(): (Object, Object) => StorageTask {
    return this.putFile;
  }

  /**
   * Upload a file path
   * @param  {string} filePath The local path of the file
   * @param  {object} metadata An object containing metadata
   * @return {Promise}
   */
  putFile(filePath: Object, metadata: Object = {}): StorageTask {
    let _filePath = filePath.replace('file://', '');
    if (_filePath.includes('%')) _filePath = decodeURI(_filePath);
    return new StorageTask(
      UPLOAD_TASK,
      getNativeModule(this._storage).putFile(this.path, _filePath, metadata),
      this
    );
  }
}