A collection-like group of documents. Can be one of CollectionReference, CollectionGroup and Query.
Optional
config: Partial<TraversalConfig>Optional. The traversal configuration with which the traverser will be created.
A new Traverser object.
For each batch of document snapshots in the traversable, this traverser invokes a specified
async callback and immediately moves to the next batch. It does not wait for the callback
Promise to resolve before moving to the next batch. That is, when maxConcurrentBatchCount
> 1,
there is no guarantee that any given batch will finish processing before a later batch.
The traverser becomes faster as you increase maxConcurrentBatchCount
, but this will consume
more memory. You should increase concurrency when you want to trade some memory for speed.
InvalidConfigError Thrown if the specified config
is invalid.
Generated using TypeDoc
Creates an object which can be used to traverse a Firestore collection or, more generally, a Traversable.