doc

Author: fredzqm

packages/firebase/index.d.ts

@@ -5435,7 +5435,24 @@ declare namespace firebase.storage {
      */
     updateMetadata(metadata: firebase.storage.SettableMetadata): Promise<any>;
     /**
-     * List items(files) and prefixes(folders) with this prefix of ref.name+'/'.
+     * List all items (files) and prefixes (folders) under this storage reference.
+     *
+     * It is a helper method for calling list() recursively until there is no
+     * more results. The default pagination size is 200.
+     *
+     * Note: the results may not be a consistent snapshot if objects are changed
+     * between paginating requests.
+     *
+     * Warning: If there are
+     *
+     * @return 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.
+     */
+    listAll(): Promise<ListResult>;
+    /**
+     * List items (files) and prefixes (folders) under this storage reference.
      *
      * GCS is a key-blob store. Firebase storage impose the semantic of '/'
      * delimited folder structure.
@@ -5468,10 +5485,10 @@ declare namespace firebase.storage {
    */
   interface ListResult {
     /**
-     * References to sub-folders. You can call list() on them to get its contents.
-     * GCS's
+     * References to prefixes (sub-folders). You can call list() on them to
+     * get its contents.
      *
-     * Folders are implict based on '/' in the object paths.
+     * Folders are implicit based on '/' in the object paths.
      * For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a')
      * will return '/a/b' as a prefix.
      */
@@ -5492,7 +5509,7 @@ declare namespace firebase.storage {
    */
   interface ListOptions {
     /**
-     * The maximum number of results (items+prefixs) returned.
+     * The maximum number of results (items and prefixes) returned.
      */
     maxResults?: number | null;
     /**

packages/storage/src/reference.ts

@@ -204,7 +204,7 @@ export class Reference {
   }
 
   /**
-   * List all items and prefixes under the current storage reference.
+   * List all items (files) and prefixes (folders) under this storage reference.
    *
    * It is a helper method for calling list() recursively until there is no
    * more results. The default pagination size is 200.
@@ -245,20 +245,30 @@ export class Reference {
   }
 
   /**
-   * List items and prefixes within this directory.
+   * List items (files) and prefixes (folders) under this storage reference.
    *
-   * "/" is treated as a path delimiter. Firebase storage does not support
-   * invalid object path that ends with "/" or contains two consecutive "//".
-   * All invalid objects in GCS will be filtered.
+   * GCS is a key-blob store. Firebase storage impose the semantic of '/'
+   * delimited folder structure.
+   * Objects whose paths, aside from the prefix, contain '/' will have
+   * their path, truncated after the '/', returned in prefixes.
+   * Duplicate prefixes are omitted.
+   * Objects whose paths, aside from the prefix, do not contain '/' will
+   * be returned in items.
+   *
+   * Firebase storage does not support invalid object paths that end with
+   * "/" or contain two consecutive "/"s. All invalid objects in GCS will be
+   * filtered by GCS.
+   * list() may fail if there are too many invalid objects in the bucket.
    *
    * @param options.maxResults If set, limits the total number of `prefixes`
-   *      and `items` to return.
+   *      and `items` to return. The default and maximum maxResults is 1000.
+   *      Use the nextPageToken to retrieve more objects.
    * @param options.pageToken The `nextPageToken` from a previous call to
    *      list(). If provided, listing is resumed from the previous position.
    * @return A promise that resolves with the items and prefixes.
-   *      `prefixes` contains references to prefixes and `items`
+   *      `prefixes` contains references to sub-folders and `items`
    *      contains references to objects in this folder. `nextPageToken`
-   *      can be passed as `options.pageToken` to get the rest of results.
+   *      can be used to get the rest of the results.
    */
   list(options?: ListOptions | null): Promise<ListResult> {
     args.validate('list', [listOptionSpec(true)], arguments);