@firebase/storage 0.7.0 → 0.7.1-2022028193537

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 #Unreleased
 
+## 0.7.1-2022028193537
+
+### Patch Changes
+
+- [`2afff2b61`](https://github.com/firebase/firebase-js-sdk/commit/2afff2b61432561e7beffefb650c506522790f13) [#5948](https://github.com/firebase/firebase-js-sdk/pull/5948) - Update node-fetch version
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/compat/cjs/compat/reference.d.ts

@@ -93,7 +93,7 @@ export declare class ReferenceCompat implements types.Reference, Compat<StorageR
      */
     list(options?: types.ListOptions | null): Promise<types.ListResult>;
     /**
-     * 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.
      */
@@ -103,19 +103,19 @@ export declare class ReferenceCompat implements types.Reference, Compat<StorageR
      * @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
      */
     updateMetadata(metadata: types.SettableMetadata): Promise<types.FullMetadata>;
     /**
-     * @returns A promise that resolves with the download
+     * @returns A `Promise` that resolves with the download
      * URL for this object.
      */
     getDownloadURL(): Promise<string>;
     /**
      * 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(): Promise<void>;
     private _throwIfRoot;

package/dist/compat/cjs/exp/api.d.ts

@@ -58,21 +58,21 @@ export declare function uploadString(ref: StorageReference, value: string, forma
  */
 export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
 /**
- * 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.
  */
 export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
 /**
  * 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.
  */
 export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
 /**
@@ -90,9 +90,9 @@ export declare function updateMetadata(ref: StorageReference, metadata: Settable
  * 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.
@@ -107,44 +107,45 @@ export declare function list(ref: StorageReference, options?: ListOptions): Prom
  * 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.
  */
 export declare function listAll(ref: StorageReference): Promise<ListResult>;
 /**
- * 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.
  */
 export declare function getDownloadURL(ref: StorageReference): Promise<string>;
 /**
  * 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.
  */
 export declare function deleteObject(ref: StorageReference): Promise<void>;
 /**
- * Returns a StorageReference for the given url.
- * @param storage - `StorageService` instance.
+ * Returns a {@link StorageReference} for the given url.
+ * @param storage - {@link FirebaseStorage} instance.
  * @param url - URL. If empty, returns root reference.
  * @public
  */
 export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
 /**
- * Returns a StorageReference for the given path in the
+ * Returns a {@link StorageReference} for the given path in the
  * default bucket.
- * @param storageOrRef - `StorageService` or `StorageReference`.
- * @param pathOrUrlStorage - path. If empty, returns root reference (if Storage
- * instance provided) or returns same reference (if Reference provided).
+ * @param storageOrRef - {@link FirebaseStorage} or {@link StorageReference}.
+ * @param pathOrUrlStorage - path. If empty, returns root reference (if {@link FirebaseStorage}
+ * instance provided) or returns same reference (if {@link StorageReference} provided).
  * @public
  */
 export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
@@ -154,18 +155,18 @@ export declare function ref(storageOrRef: FirebaseStorage | StorageReference, pa
 export declare function _getChild(ref: StorageReference, childPath: string): Reference;
 export { StringFormat } from '../src/implementation/string';
 /**
- * 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.
  */
 export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
 /**
- * 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.

package/dist/compat/cjs/exp/public-types.d.ts

@@ -65,7 +65,7 @@ export interface StorageReference {
      */
     name: string;
     /**
-     * The StorageService associated with this reference.
+     * The {@link FirebaseStorage} instance associated with this reference.
      */
     storage: FirebaseStorage;
     /**

package/dist/compat/cjs/index.js

@@ -733,7 +733,7 @@ var ReferenceCompat = /** @class */ (function () {
         return storage.list(this._delegate, options || undefined).then(function (r) { return 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.
      */
@@ -745,7 +745,7 @@ var ReferenceCompat = /** @class */ (function () {
      * @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
      */
@@ -753,7 +753,7 @@ var ReferenceCompat = /** @class */ (function () {
         return storage.updateMetadata(this._delegate, metadata);
     };
     /**
-     * @returns A promise that resolves with the download
+     * @returns A `Promise` that resolves with the download
      * URL for this object.
      */
     ReferenceCompat.prototype.getDownloadURL = function () {
@@ -761,7 +761,7 @@ var ReferenceCompat = /** @class */ (function () {
     };
     /**
      * Deletes the object at this location.
-     * @returns A promise that resolves if the deletion succeeds.
+     * @returns A `Promise` that resolves if the deletion succeeds.
      */
     ReferenceCompat.prototype.delete = function () {
         this._throwIfRoot('delete');