@firebase/storage 0.7.0 → 0.7.1-2022028193537

package/dist/index.node.cjs.js

@@ -2800,7 +2800,7 @@ async function list$1(ref, options) {
     return (await ref.storage.makeRequestWithTokens(requestInfo)).getPromise();
 }
 /**
- * A promise that resolves with the metadata for this object. If this
+ * 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.
  * @public
@@ -2818,7 +2818,7 @@ async function getMetadata$1(ref) {
  * @param metadata - The new metadata for the object.
  *     Only values that have been explicitly set will be changed. Explicitly
  *     setting a value to null will remove the metadata.
- * @returns A promise that resolves
+ * @returns A `Promise` that resolves
  *     with the new metadata for this object.
  *     See `firebaseStorage.Reference.prototype.getMetadata`
  */
@@ -2830,7 +2830,7 @@ async function updateMetadata$1(ref, metadata) {
 /**
  * Returns the download URL for the given Reference.
  * @public
- * @returns A promise that resolves with the download
+ * @returns A `Promise` that resolves with the download
  *     URL for this object.
  */
 async function getDownloadURL$1(ref) {
@@ -2849,7 +2849,7 @@ async function getDownloadURL$1(ref) {
  * Deletes the object at this location.
  * @public
  * @param ref - StorageReference for object to delete.
- * @returns A promise that resolves if the deletion succeeds.
+ * @returns A `Promise` that resolves if the deletion succeeds.
  */
 async function deleteObject$1(ref) {
     ref._throwIfRoot('deleteObject');
@@ -3140,11 +3140,11 @@ function uploadBytesResumable(ref, data, metadata) {
     return uploadBytesResumable$1(ref, data, metadata);
 }
 /**
- * A promise that resolves with the metadata for this object. If this
+ * 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.
  * @public
- * @param ref - StorageReference to get metadata from.
+ * @param ref - {@link StorageReference} to get metadata from.
  */
 function getMetadata(ref) {
     ref = util.getModularInstance(ref);
@@ -3153,11 +3153,11 @@ function getMetadata(ref) {
 /**
  * Updates the metadata for this object.
  * @public
- * @param ref - StorageReference to update metadata for.
+ * @param ref - {@link StorageReference} to update metadata for.
  * @param metadata - The new metadata for the object.
  *     Only values that have been explicitly set will be changed. Explicitly
  *     setting a value to null will remove the metadata.
- * @returns A promise that resolves with the new metadata for this object.
+ * @returns A `Promise` that resolves with the new metadata for this object.
  */
 function updateMetadata(ref, metadata) {
     ref = util.getModularInstance(ref);
@@ -3178,9 +3178,9 @@ function updateMetadata(ref, metadata) {
  * list() may fail if there are too many unsupported objects in the bucket.
  * @public
  *
- * @param ref - StorageReference to get list from.
- * @param options - See ListOptions for details.
- * @returns A Promise that resolves with the items and prefixes.
+ * @param ref - {@link StorageReference} to get list from.
+ * @param options - See {@link ListOptions} for details.
+ * @returns A `Promise` that resolves with the items and prefixes.
  *      `prefixes` contains references to sub-folders and `items`
  *      contains references to objects in this folder. `nextPageToken`
  *      can be used to get the rest of the results.
@@ -3198,12 +3198,12 @@ function list(ref, options) {
  * 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
+ * Warning: `listAll` may potentially consume too many resources if there are
  * too many results.
  * @public
- * @param ref - StorageReference to get list from.
+ * @param ref - {@link StorageReference} to get list from.
  *
- * @returns A Promise that resolves with all the items and prefixes under
+ * @returns A `Promise` that resolves with all the items and prefixes under
  *      the current storage reference. `prefixes` contains references to
  *      sub-directories and `items` contains references to objects in this
  *      folder. `nextPageToken` is never returned.
@@ -3213,9 +3213,10 @@ function listAll(ref) {
     return listAll$1(ref);
 }
 /**
- * Returns the download URL for the given Reference.
+ * Returns the download URL for the given {@link StorageReference}.
  * @public
- * @returns A promise that resolves with the download
+ * @param ref - {@link StorageReference} to get the download URL for.
+ * @returns A `Promise` that resolves with the download
  *     URL for this object.
  */
 function getDownloadURL(ref) {
@@ -3225,8 +3226,8 @@ function getDownloadURL(ref) {
 /**
  * Deletes the object at this location.
  * @public
- * @param ref - StorageReference for object to delete.
- * @returns A promise that resolves if the deletion succeeds.
+ * @param ref - {@link StorageReference} for object to delete.
+ * @returns A `Promise` that resolves if the deletion succeeds.
  */
 function deleteObject(ref) {
     ref = util.getModularInstance(ref);
@@ -3243,9 +3244,9 @@ function _getChild(ref, childPath) {
     return _getChild$1(ref, childPath);
 }
 /**
- * Modify this `StorageService` instance to communicate with the Cloud Storage emulator.
+ * Modify this {@link FirebaseStorage} instance to communicate with the Cloud Storage emulator.
  *
- * @param storage - The `StorageService` instance
+ * @param storage - The {@link FirebaseStorage} instance
  * @param host - The emulator host (ex: localhost)
  * @param port - The emulator port (ex: 5001)
  * @param options.mockUserToken - the mock auth token to use for unit testing Security Rules.
@@ -3487,7 +3488,7 @@ class ReferenceCompat {
         return list(this._delegate, options || undefined).then(r => new ListResultCompat(r, this.storage));
     }
     /**
-     * A promise that resolves with the metadata for this object. If this
+     * 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.
      */
@@ -3499,7 +3500,7 @@ class ReferenceCompat {
      * @param metadata - The new metadata for the object.
      * Only values that have been explicitly set will be changed. Explicitly
      * setting a value to null will remove the metadata.
-     * @returns A promise that resolves
+     * @returns A `Promise` that resolves
      * with the new metadata for this object.
      * @see firebaseStorage.Reference.prototype.getMetadata
      */
@@ -3507,7 +3508,7 @@ class ReferenceCompat {
         return updateMetadata(this._delegate, metadata);
     }
     /**
-     * @returns A promise that resolves with the download
+     * @returns A `Promise` that resolves with the download
      * URL for this object.
      */
     getDownloadURL() {
@@ -3515,7 +3516,7 @@ class ReferenceCompat {
     }
     /**
      * Deletes the object at this location.
-     * @returns A promise that resolves if the deletion succeeds.
+     * @returns A `Promise` that resolves if the deletion succeeds.
      */
     delete() {
         this._throwIfRoot('delete');
@@ -3597,7 +3598,7 @@ class StorageServiceCompat {
 }
 
 const name = "@firebase/storage";
-const version = "0.7.0";
+const version = "0.7.1-2022028193537";
 
 /**
  * @license