Skip to content

Commit 035e760

Browse files
authored
Update reference.ts
1 parent fd6ee14 commit 035e760

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

packages/storage/src/reference.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -206,15 +206,15 @@ export class Reference {
206206
/**
207207
* List all items (files) and prefixes (folders) under this storage reference.
208208
*
209-
* This is a helper method for calling list() repeatedly until there are no
210-
* more results. The default pagination size is 1000.
211-
*
212-
* Note: The results may not be a consistent snapshot if objects are changed
213-
* between paginating requests.
214-
*
215209
* This is a helper method for calling list() repeatedly until there are
216210
* no more results. The default pagination size is 1000.
217211
*
212+
* Note: The results may not be consistent if objects are changed while this
213+
* operation is running.
214+
*
215+
* Warning: listAll may potentially consume too many resources if there are
216+
* too many results.
217+
*
218218
* @return A Promise that resolves with all the items and prefixes under
219219
* the current storage reference. `prefixes` contains references to
220220
* sub-directories and `items` contains references to objects in this
@@ -244,15 +244,15 @@ export class Reference {
244244
await this.listAllHelper(accumulator, nextPage.nextPageToken);
245245
}
246246
}
247-
247+
248248
/**
249249
* List items (files) and prefixes (folders) under this storage reference.
250250
*
251251
* GCS is a key-blob store. Firebase Storage imposes the semantic of '/'
252252
* delimited folder structure.
253253
* Refer to GCS's List API if you want to learn more.
254254
*
255-
* To adhere to Firebase Rules's Semantics, Firebase storage does not
255+
* To adhere to Firebase Rules's Semantics, Firebase Storage does not
256256
* support objects whose paths end with "/" or contain two consecutive
257257
* "/"s. Firebase Storage List API will filter these unsupported objects.
258258
* list() may fail if there are too many unsupported objects in the bucket.
@@ -262,7 +262,7 @@ export class Reference {
262262
* Use the nextPageToken to retrieve more objects.
263263
* @param options.pageToken The `nextPageToken` from a previous call to
264264
* list(). If provided, listing is resumed from the previous position.
265-
* @return A promise that resolves with the items and prefixes.
265+
* @return A Promise that resolves with the items and prefixes.
266266
* `prefixes` contains references to sub-folders and `items`
267267
* contains references to objects in this folder. `nextPageToken`
268268
* can be used to get the rest of the results.

0 commit comments

Comments
 (0)