Firestore extension type

Firestore represents a Firestore Database and is the entry point for all Firestore operations.

on

• JSObject

Implemented types

• JSObject

Available extensions

• FirebaseJsInteropJSObjectExtension
• JSObjectUnsafeUtilExtension

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

batch() → WriteBatch

Creates a write batch, used for performing multiple writes as a single atomic operation.

bulkWriter([BulkWriterOptions options]) → BulkWriter

Creates a BulkWriter{@link BulkWriter}, used for performing multiple writes in parallel. Gradually ramps up writes as specified by the 500/50/5 rule.

bundle([String bundleId]) → BundleBuilder

Creates a new BundleBuilder instance to package selected Firestore data into a bundle.

collection(String collectionPath) → CollectionReference

Gets a CollectionReference instance that refers to the collection at the specified path.

collectionGroup(String collectionId) → CollectionGroup

Creates and returns a new Query that includes all documents in the database that are contained in a collection or subcollection with the given collectionId.

databaseId() → String

Returns the Database ID for this Firestore instance.

doc(String documentPath) → DocumentReference

Gets a DocumentReference instance that refers to the document at the specified path.

listCollections() → JSPromise<JSArray<CollectionReference>>

Fetches the root collections that are associated with this Firestore database.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

recursiveDelete(JSObject ref, [BulkWriter bulkWriter]) → JSPromise<JSAny?>

Retrieves multiple documents from Firestore.

runTransaction<T extends JSAny>(JSFunction updateFunction, [JSObject transactionOptions]) → JSPromise<T>

Executes the given updateFunction and commits the changes applied within the transaction.

settings(Settings settings) → void

Specifies custom settings to be used to configure the Firestore instance. Can only be invoked once and before any other Firestore method.

terminate() → JSPromise<JSAny?>

Terminates the Firestore client and closes all open streams.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited