Back to Firebase Js Sdk

ListOptions interface

docs-devsite/storage.listoptions.md

12.12.11.3 KB
Original Source

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 %}

ListOptions interface

The options list() accepts.

<b>Signature:</b>

typescript
export interface ListOptions 

Properties

PropertyTypeDescription
maxResultsnumber | nullIf set, limits the total number of <code>prefixes</code> and <code>items</code> to return. The default and maximum maxResults is 1000.
pageTokenstring | nullThe <code>nextPageToken</code> from a previous call to <code>list()</code>. If provided, listing is resumed from the previous position.

ListOptions.maxResults

If set, limits the total number of prefixes and items to return. The default and maximum maxResults is 1000.

<b>Signature:</b>

typescript
maxResults?: number | null;

ListOptions.pageToken

The nextPageToken from a previous call to list()<!-- -->. If provided, listing is resumed from the previous position.

<b>Signature:</b>

typescript
pageToken?: string | null;