Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.
Signature:
export declare interface Settings
Properties
| Property | Type | Description |
|---|---|---|
| grpcFlowControlWindow | number | Only applicable in Node environments.The gRPC flow control window size in bytes. Defaults to 256 KB. This maps directly to grpc-node's grpc-node.flow_control_window setting.**WARNING:** This is an advanced setting. The default of 256 KB is optimized for most Node workloads. Only modify this if you are actively tuning gRPC network behavior and understand the implications of HTTP/2 flow control. |
| host | string | The hostname to connect to. |
| ignoreUndefinedProperties | boolean | 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 to false or omitted, the SDK throws an exception when it encounters properties of type undefined. |
| ssl | boolean | Whether to use SSL when connecting. |
Settings.grpcFlowControlWindow
Only applicable in Node environments.
The gRPC flow control window size in bytes. Defaults to 256 KB. This maps directly to grpc-node's grpc-node.flow_control_window setting.
**WARNING:** This is an advanced setting. The default of 256 KB is optimized for most Node workloads. Only modify this if you are actively tuning gRPC network behavior and understand the implications of HTTP/2 flow control.
Signature:
grpcFlowControlWindow?: number;
Settings.host
The hostname to connect to.
Signature:
host?: string;
Settings.ignoreUndefinedProperties
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 to false or omitted, the SDK throws an exception when it encounters properties of type undefined.
Signature:
ignoreUndefinedProperties?: boolean;
Settings.ssl
Whether to use SSL when connecting.
Signature:
ssl?: boolean;