List Files on Web

Cloud Storage allows you to list the contents of your Storage Bucket. The SDKs return both the items and the prefixes of objects under the current Storage reference.

Projects that use the List API require Firebase Storage Rules Version 2. If you have an existing Firebase Project, please follow the steps in the Security Rules Guide.

List() uses Google Cloud Storage’s List API. In Firebase Storage, we use / as a delimiter, which allows us to emulate file system semantics. To allow for efficient traversal of large, hierarchical Storage Buckets, the List API returns prefixes and items separately. For example, if you upload one file /images/uid/file1,

• root.child('images').listAll() will return /images/uid as a prefix.
• root.child('images/uid').listAll() will return the file as an item.

The Firebase Storage SDK does not return object paths that contain two consecutive /s or end with a /.. For example, if a bucket has the following objects:

• happyPrefix/happyItem
• sadPrefix//sadItem
• lonelyItem/

List operations on items in this bucket will give the following results: * The list operation at the root returns the references to happyPrefix, sadPrefix and lonelyPrefix as prefixes. * The list operation at the happyPrefix/ returns the references to happyPrefix/happyItem as items. * The list operation at the sadPrefix/ doesn't return any references because sadPrefix//sadItem contains two consecutive /s. * The list operation at the lonelyItem/ doesn't return any references because the object lonelyItem/ ends with /.

List all files

You can use listAll to fetch all results for a directory. This is best used for small directories as all results are buffered in memory. The operation also may not return a consistent snapshot if objects are added or removed during the process.

For a large list, use the paginated list() method as listAll() buffers all results in memory.

The following example demonstrates listAll.

// Create a reference under which you want to list
var listRef = storageRef.child('files/uid');

// Find all the prefixes and items.
listRef.listAll().then(function(res) {
  res.prefixes.forEach(function(folderRef) {
    // All the prefixes under listRef.
    // You may call listAll() recursively on them.
  });
  res.items.forEach(function(itemRef) {
    // All the items under listRef.
  });
}).catch(function(error) {
  // Uh-oh, an error occurred!
});

Paginate list results

The list() API places a limit on the number of results it returns. list() provides a consistent pageview and exposes a pageToken that allows control over when to fetch additional results.

The pageToken encodes the path and version of the last item returned in the previous result. In a subsequent request using the pageToken, items that come after the pageToken are shown.

The following example demonstrates paginating a result using async/await.

async function pageTokenExample(){
  // Create a reference under which you want to list
  var listRef = storageRef.child('files/uid');
  // Fetch the first page of 100.
  var firstPage = await listRef.list({ maxResults: 100});
  // Use the result.
  // processItems(firstPage.items)
  // processPrefiexes(firstPage.prefixes)
  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    var secondPage = await listRef.list({
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefiexes(secondPage.prefixes)
  }
}

Handle errors

list() and listAll() return a rejected Promise if you haven't upgraded the Security Rules to version 2. Upgrade your Security Rules if you see this error:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

Other possible errors may indicate the user does not have the right permission. More information on errors can be found in the Handle Errors.