Settings extension type

Settings used to directly configure a Firestore instance.

on
Implemented types
Available extensions

Constructors

Settings({String? projectId, String? databaseId, String? host, int? port, String? keyFilename, JSObject? credentials, bool? ssl, int? maxIdleChannels, bool? useBigInt, bool? ignoreUndefinedProperties, bool? preferRest})
Constructor
factory

Properties

credentials → JSObject?
The 'client_email' and 'private_key' properties of the service account to use with your Firestore project. Can be omitted in environments that support {@link https://cloud.google.com/docs/authentication Application Default Credentials}. If your credentials are stored in a JSON file, you can specify a keyFilename instead.
no setter
databaseId → String?
The database name. If omitted, the default database will be used.
no setter
hashCode → int
The hash code for this object.
no setterinherited
host → String?
The hostname to connect to.
no setter
ignoreUndefinedProperties → bool?
Whether to skip nested properties that are set to undefined during object serialization. If set to true, these properties are skipped and not written to Firestore. If set false or omitted, the SDK throws an exception when it encounters properties of type undefined.
no setter
keyFilename → String?
Local file containing the Service Account credentials as downloaded from the Google Developers Console. Can be omitted in environments that support {@link https://cloud.google.com/docs/authentication Application Default Credentials}. To configure Firestore with custom credentials, use the credentials property to provide the client_email and private_key of your service account.
no setter
maxIdleChannels → int?
The maximum number of idle GRPC channels to keep. A smaller number of idle channels reduces memory usage but increases request latency for clients with fluctuating request rates. If set to 0, shuts down all GRPC channels when the client becomes idle. Defaults to 1.
no setter
port → int?
The port to connect to.
no setter
preferRest → bool?
Whether to force the use of HTTP/1.1 REST transport until a method that requires gRPC is called. When a method requires gRPC, this Firestore client will load dependent gRPC libraries and then use gRPC transport for communication from that point forward. Currently the only operation that requires gRPC is creating a snapshot listener with the method DocumentReference<T>.onSnapshot(), CollectionReference<T>.onSnapshot(), or Query<T>.onSnapshot().
no setter
projectId → String?
The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. Can be omitted in environments that support {@link https://cloud.google.com/docs/authentication Application Default Credentials}
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
ssl → bool?
Whether to use SSL when connecting.
no setter
useBigInt → bool?
Whether to use BigInt for integer types when deserializing Firestore Documents. Regardless of magnitude, all integer values are returned as BigInt to match the precision of the Firestore backend. Floating point numbers continue to use JavaScript's number type.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited