@firebase/storage 0.7.0 → 0.7.1-2022028193537

package/exp/dist/index.node.cjs.js

@@ -2820,7 +2820,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
@@ -2838,7 +2838,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`
  */
@@ -2850,7 +2850,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) {
@@ -2869,7 +2869,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');
@@ -3131,7 +3131,7 @@ class FirebaseStorageImpl {
 }
 
 const name = "@firebase/storage";
-const version = "0.7.0";
+const version = "0.7.1-2022028193537";
 
 /**
  * @license
@@ -3211,11 +3211,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);
@@ -3224,11 +3224,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);
@@ -3249,9 +3249,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.
@@ -3269,12 +3269,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.
@@ -3284,9 +3284,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) {
@@ -3296,8 +3297,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);
@@ -3314,12 +3315,12 @@ function _getChild(ref, childPath) {
     return _getChild$1(ref, childPath);
 }
 /**
- * Gets a Firebase StorageService instance for the given Firebase app.
+ * Gets a {@link FirebaseStorage} instance for the given Firebase app.
  * @public
- * @param app - Firebase app to get Storage instance for.
+ * @param app - Firebase app to get {@link FirebaseStorage} instance for.
  * @param bucketUrl - The gs:// url to your Firebase Storage Bucket.
  * If not passed, uses the app's default Storage Bucket.
- * @returns A Firebase StorageService instance.
+ * @returns A {@link FirebaseStorage} instance.
  */
 function getStorage(app$1 = app.getApp(), bucketUrl) {
     app$1 = util.getModularInstance(app$1);
@@ -3330,9 +3331,9 @@ function getStorage(app$1 = app.getApp(), bucketUrl) {
     return storageInstance;
 }
 /**
- * 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.