Class BundleBuilder (7.11.0)

Builds a Firestore data bundle with results from the given document and query snapshots.

Package

@google-cloud/firestore

Constructors

(constructor)(bundleId)

constructor(bundleId: string);

Constructs a new instance of the BundleBuilder class

Parameter
Name Description
bundleId string

Properties

bundleId

readonly bundleId: string;

Methods

add(documentSnapshot)

add(documentSnapshot: DocumentSnapshot): BundleBuilder;
Parameter
Name Description
documentSnapshot DocumentSnapshot
Returns
Type Description
BundleBuilder

add(queryName, querySnapshot)

add(queryName: string, querySnapshot: QuerySnapshot): BundleBuilder;
Parameters
Name Description
queryName string
querySnapshot QuerySnapshot
Returns
Type Description
BundleBuilder

build()

build(): Buffer;
Returns
Type Description
Buffer