Stay organized with collections
Save and categorize content based on your preferences.
Options that configure the SDK’s underlying network transport (WebChannel) when long-polling is used.
See FirestoreSettings.experimentalAutoDetectLongPolling, FirestoreSettings.experimentalForceLongPolling, and FirestoreSettings.experimentalLongPollingOptions.
The desired maximum timeout interval, in seconds, to complete a long-polling GET response. Valid values are between 5 and 30, inclusive. Floating point values are allowed and will be rounded to the nearest millisecond.By default, when long-polling is used the "hanging GET" request sent by the client times out after 30 seconds. To request a different timeout from the server, set this setting with the desired timeout.Changing the default timeout may be useful, for example, if the buffering proxy that necessitated enabling long-polling in the first place has a shorter timeout for hanging GET requests, in which case setting the long-polling timeout to a shorter value, such as 25 seconds, may fix prematurely-closed hanging GET requests. For example, see https://github.com/firebase/firebase-js-sdk/issues/6987.
ExperimentalLongPollingOptions.timeoutSeconds
The desired maximum timeout interval, in seconds, to complete a long-polling GET response. Valid values are between 5 and 30, inclusive. Floating point values are allowed and will be rounded to the nearest millisecond.
By default, when long-polling is used the "hanging GET" request sent by the client times out after 30 seconds. To request a different timeout from the server, set this setting with the desired timeout.
Changing the default timeout may be useful, for example, if the buffering proxy that necessitated enabling long-polling in the first place has a shorter timeout for hanging GET requests, in which case setting the long-polling timeout to a shorter value, such as 25 seconds, may fix prematurely-closed hanging GET requests. For example, see https://github.com/firebase/firebase-js-sdk/issues/6987.
[null,null,["Last updated 2023-05-12 UTC."],[],[],null,["# ExperimentalLongPollingOptions interface\n\nOptions that configure the SDK's underlying network transport (WebChannel) when long-polling is used.\n| **Note:** This interface is \"experimental\" and is subject to change.\n\nSee `FirestoreSettings.experimentalAutoDetectLongPolling`, `FirestoreSettings.experimentalForceLongPolling`, and `FirestoreSettings.experimentalLongPollingOptions`.\n\n**Signature:** \n\n export declare interface ExperimentalLongPollingOptions \n\nProperties\n----------\n\n| Property | Type | Description |\n|---------------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [timeoutSeconds](./firestore_.experimentallongpollingoptions.md#experimentallongpollingoptionstimeoutseconds) | number | The desired maximum timeout interval, in seconds, to complete a long-polling GET response. Valid values are between 5 and 30, inclusive. Floating point values are allowed and will be rounded to the nearest millisecond.By default, when long-polling is used the \"hanging GET\" request sent by the client times out after 30 seconds. To request a different timeout from the server, set this setting with the desired timeout.Changing the default timeout may be useful, for example, if the buffering proxy that necessitated enabling long-polling in the first place has a shorter timeout for hanging GET requests, in which case setting the long-polling timeout to a shorter value, such as 25 seconds, may fix prematurely-closed hanging GET requests. For example, see https://github.com/firebase/firebase-js-sdk/issues/6987. |\n\nExperimentalLongPollingOptions.timeoutSeconds\n---------------------------------------------\n\nThe desired maximum timeout interval, in seconds, to complete a long-polling GET response. Valid values are between 5 and 30, inclusive. Floating point values are allowed and will be rounded to the nearest millisecond.\n\nBy default, when long-polling is used the \"hanging GET\" request sent by the client times out after 30 seconds. To request a different timeout from the server, set this setting with the desired timeout.\n\nChanging the default timeout may be useful, for example, if the buffering proxy that necessitated enabling long-polling in the first place has a shorter timeout for hanging GET requests, in which case setting the long-polling timeout to a shorter value, such as 25 seconds, may fix prematurely-closed hanging GET requests. For example, see https://github.com/firebase/firebase-js-sdk/issues/6987.\n\n**Signature:** \n\n timeoutSeconds?: number;"]]
