Spécifie les configurations personnalisées pour votre instance Cloud Firestore. Vous devez les définir avant d'invoquer d'autres méthodes.
Signature:
export declare interface FirestoreSettings
Propriétés
| Propriété | Taper | Description |
|---|---|---|
| cacheSizeBytes | nombre | REMARQUE : ce champ sera obsolète dans une prochaine version majeure. Utilisez plutôt le champ cache pour spécifier la taille du cache et d'autres configurations de cache. Un seuil approximatif de taille de cache pour les données sur disque. Si le cache dépasse cette taille, Firestore commencera à supprimer les données qui n'ont pas été récemment utilisées. La taille ne garantit pas que le cache restera en dessous de cette taille, mais seulement que si le cache dépasse la taille donnée, un nettoyage sera tenté. La valeur par défaut est de 40 Mo. Le seuil doit être défini sur au moins 1 Mo et peut être défini sur CACHE_SIZE_UNLIMITED pour désactiver le garbage collection. |
| experimentalAutoDetectLongPolling | booléen | Configure le transport sous-jacent du SDK (WebChannel) pour détecter automatiquement si l'interrogation longue doit être utilisée. Ceci est très similaire à experimentalForceLongPolling , mais n'utilise une interrogation longue que si nécessaire. Après avoir eu une valeur par défaut de false depuis sa création en 2019, la valeur par défaut de ce paramètre a été modifiée en mai 2023 en true dans la v9.22.0 du SDK JavaScript Firebase. Autrement dit, la détection automatique des interrogations longues est désormais activée par défaut. Pour le désactiver, définissez ce paramètre sur false et ouvrez un ticket GitHub pour partager les problèmes qui vous ont motivé à désactiver la détection automatique des interrogations longues. Ce paramètre ne peut pas être utilisé dans un environnement Node.js. |
| expérimentalForceLongPolling | booléen | Force le transport réseau sous-jacent du SDK (WebChannel) à utiliser l'interrogation longue. Chaque réponse du backend sera fermée immédiatement après que le backend ait envoyé des données (par défaut, les réponses restent ouvertes au cas où le backend aurait plus de données à envoyer). Cela évite les problèmes d'incompatibilité avec certains proxys, logiciels antivirus, etc. qui mettent indéfiniment en mémoire tampon le trafic de manière incorrecte. L'utilisation de cette option entraînera cependant une certaine dégradation des performances. Ce paramètre ne peut pas être utilisé avec experimentalAutoDetectLongPolling et pourra être supprimé dans une version ultérieure. Si vous l'utilisez pour contourner un problème spécifique de fiabilité du réseau, veuillez nous en informer sur https://github.com/firebase/firebase-js-sdk/issues/1674. Ce paramètre ne peut pas être utilisé dans un environnement Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptions | Options qui configurent le transport réseau sous-jacent du SDK (WebChannel) lorsque l'interrogation longue est utilisée. Ces options ne sont utilisées que si experimentalForceLongPolling est vrai ou si experimentalAutoDetectLongPolling est vrai et que la détection automatique a déterminé qu'une interrogation longue était nécessaire. Sinon, ces options n'ont aucun effet. |
| hôte | chaîne | Le nom d'hôte auquel se connecter. |
| ignoreUndefinedProperties | booléen | Indique s'il faut ignorer les propriétés imbriquées définies sur undefined lors de la sérialisation des objets. Si elles sont définies sur true , ces propriétés sont ignorées et ne sont pas écrites dans Firestore. S'il est défini sur false ou omis, le SDK lève une exception lorsqu'il rencontre des propriétés de type undefined . |
| cache local | FirestoreLocalCache | Spécifie le cache utilisé par le SDK. Les options disponibles sont MemoryLocalCache et PersistentLocalCache , chacune avec des options de configuration différentes. Lorsqu'il n'est pas spécifié, MemoryLocalCache sera utilisé par défaut. REMARQUE : la définition de ce champ et cacheSizeBytes en même temps générera une exception lors de l'initialisation du SDK. Utilisez plutôt la configuration de l'objet FirestoreLocalCache pour spécifier la taille du cache. |
| SSL | booléen | S'il faut utiliser SSL lors de la connexion. |
FirestoreSettings.cacheSizeBytes
REMARQUE : ce champ sera obsolète dans une prochaine version majeure. Utilisez plutôt le champ cache pour spécifier la taille du cache et d'autres configurations de cache.
Un seuil approximatif de taille de cache pour les données sur disque. Si le cache dépasse cette taille, Firestore commencera à supprimer les données qui n'ont pas été récemment utilisées. La taille ne garantit pas que le cache restera en dessous de cette taille, mais seulement que si le cache dépasse la taille donnée, un nettoyage sera tenté.
La valeur par défaut est de 40 Mo. Le seuil doit être défini sur au moins 1 Mo et peut être défini sur CACHE_SIZE_UNLIMITED pour désactiver le garbage collection.
Signature:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Configure le transport sous-jacent du SDK (WebChannel) pour détecter automatiquement si l'interrogation longue doit être utilisée. Ceci est très similaire à experimentalForceLongPolling , mais n'utilise l'interrogation longue que si nécessaire.
Après avoir eu une valeur par défaut de false depuis sa création en 2019, la valeur par défaut de ce paramètre a été modifiée en mai 2023 en true dans la v9.22.0 du SDK JavaScript Firebase. Autrement dit, la détection automatique des interrogations longues est désormais activée par défaut. Pour le désactiver, définissez ce paramètre sur false , et veuillez ouvrir un ticket GitHub pour partager les problèmes qui vous ont motivé à désactiver la détection automatique des interrogations longues.
Ce paramètre ne peut pas être utilisé dans un environnement Node.js.
Signature:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Force le transport réseau sous-jacent du SDK (WebChannel) à utiliser l'interrogation longue. Chaque réponse du backend sera fermée immédiatement après que le backend ait envoyé des données (par défaut, les réponses restent ouvertes au cas où le backend aurait plus de données à envoyer). Cela évite les problèmes d'incompatibilité avec certains proxys, logiciels antivirus, etc. qui mettent indéfiniment en mémoire tampon le trafic de manière incorrecte. L'utilisation de cette option entraînera cependant une certaine dégradation des performances.
Ce paramètre ne peut pas être utilisé avec experimentalAutoDetectLongPolling et pourra être supprimé dans une version ultérieure. Si vous l'utilisez pour contourner un problème spécifique de fiabilité du réseau, veuillez nous en informer sur https://github.com/firebase/firebase-js-sdk/issues/1674.
Ce paramètre ne peut pas être utilisé dans un environnement Node.js.
Signature:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Options qui configurent le transport réseau sous-jacent du SDK (WebChannel) lorsque l'interrogation longue est utilisée.
Ces options ne sont utilisées que si experimentalForceLongPolling est vrai ou si experimentalAutoDetectLongPolling est vrai et que la détection automatique a déterminé qu'une interrogation longue était nécessaire. Sinon, ces options n'ont aucun effet.
Signature:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Le nom d'hôte auquel se connecter.
Signature:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Indique s'il faut ignorer les propriétés imbriquées définies sur undefined lors de la sérialisation des objets. Si défini sur true , ces propriétés sont ignorées et ne sont pas écrites dans Firestore. S'il est défini sur false ou omis, le SDK lève une exception lorsqu'il rencontre des propriétés de type undefined .
Signature:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Spécifie le cache utilisé par le SDK. Les options disponibles sont MemoryLocalCache et PersistentLocalCache , chacun avec des options de configuration différentes.
Lorsqu'il n'est pas spécifié, MemoryLocalCache sera utilisé par défaut.
REMARQUE : la définition de ce champ et cacheSizeBytes en même temps générera une exception lors de l'initialisation du SDK. Utilisez plutôt la configuration de l'objet FirestoreLocalCache pour spécifier la taille du cache.
Signature:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
S'il faut utiliser SSL lors de la connexion.
Signature:
ssl?: boolean;