Files

2.0 KiB

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

ListResult interface

Result returned by list().

Signature:

export interface ListResult 

Properties

Property Type Description
items StorageReference[] Objects in this directory. You can call getMetadata() and getDownloadUrl() on them.
nextPageToken string If set, there might be more results for this list. Use this token to resume the list.
prefixes StorageReference[] References to prefixes (sub-folders). You can call list() on them to get its contents.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.

ListResult.items

Objects in this directory. You can call getMetadata() and getDownloadUrl() on them.

Signature:

items: StorageReference[];

ListResult.nextPageToken

If set, there might be more results for this list. Use this token to resume the list.

Signature:

nextPageToken?: string;

ListResult.prefixes

References to prefixes (sub-folders). You can call list() on them to get its contents.

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.

Signature:

prefixes: StorageReference[];