@firebase/storage 0.7.0 → 0.7.1-2022028193537

package/exp/dist/src/reference.d.ts

@@ -151,7 +151,7 @@ export declare function listAll(ref: Reference): Promise<ListResult>;
  */
 export declare function list(ref: Reference, options?: ListOptions | null): Promise<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.
  * @public
@@ -165,7 +165,7 @@ export declare function getMetadata(ref: Reference): Promise<Metadata>;
  * @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`
  */
@@ -173,7 +173,7 @@ export declare function updateMetadata(ref: Reference, metadata: Partial<Metadat
 /**
  * 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.
  */
 export declare function getDownloadURL(ref: Reference): Promise<string>;
@@ -181,7 +181,7 @@ export declare function getDownloadURL(ref: Reference): 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.
+ * @returns A `Promise` that resolves if the deletion succeeds.
  */
 export declare function deleteObject(ref: Reference): Promise<void>;
 /**

package/exp/dist/storage-public.d.ts

@@ -15,9 +15,9 @@ import { Provider } from '@firebase/component';
 import { Subscribe } from '@firebase/util';
 import { Unsubscribe } from '@firebase/util';
 /**
- * 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.
@@ -29,8 +29,8 @@ export declare function connectStorageEmulator(storage: FirebaseStorage, host: s
 /**
  * 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>;
 /* Excluded from this release type: _FbsBlob */
@@ -119,27 +119,28 @@ export declare interface FullMetadata extends UploadMetadata {
 }
 /* Excluded from this release type: _getChild */
 /**
- * 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>;
 /**
- * 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>;
 /**
- * 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;
 /**
@@ -157,9 +158,9 @@ export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): Fireb
  * 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.
@@ -174,12 +175,12 @@ 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.
@@ -226,18 +227,18 @@ export declare interface ListResult {
     nextPageToken?: string;
 }
 /**
- * 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;
@@ -312,7 +313,7 @@ export declare interface StorageReference {
      */
     name: string;
     /**
-     * The StorageService associated with this reference.
+     * The {@link FirebaseStorage} instance associated with this reference.
      */
     storage: FirebaseStorage;
     /**
@@ -393,11 +394,11 @@ export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' |
 /**
  * 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>;
 /**

package/exp/dist/storage.d.ts

@@ -47,9 +47,9 @@ declare class ConnectionPool {
 }
 
 /**
- * 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.
@@ -62,8 +62,8 @@ export declare function connectStorageEmulator(storage: FirebaseStorage, host: s
 /**
  * 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>;
 
@@ -318,29 +318,30 @@ export declare interface FullMetadata extends UploadMetadata {
 export declare function _getChild(ref: StorageReference, childPath: string): _Reference;
 
 /**
- * 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>;
 
 /**
- * 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>;
 
 /**
- * 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;
 
@@ -395,9 +396,9 @@ declare const enum InternalTaskState {
  * 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.
@@ -413,12 +414,12 @@ 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.
@@ -516,19 +517,19 @@ declare interface Metadata extends FullMetadata {
 declare type NextFn_2<T> = (value: T) => 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;
@@ -759,7 +760,7 @@ export declare interface StorageReference {
      */
     name: string;
     /**
-     * The StorageService associated with this reference.
+     * The {@link FirebaseStorage} instance associated with this reference.
      */
     storage: FirebaseStorage;
     /**
@@ -919,11 +920,11 @@ declare type Unsubscribe_2 = () => void;
 /**
  * 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>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/storage",
-  "version": "0.7.0",
+  "version": "0.7.1-2022028193537",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -41,7 +41,7 @@
     "@firebase/storage-types": "0.5.0",
     "@firebase/util": "1.3.0",
     "@firebase/component": "0.5.6",
-    "node-fetch": "2.6.1",
+    "node-fetch": "2.6.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {