FirestoreSettings interface

Cloud Firestore 인스턴스의 커스텀 구성을 지정합니다. 다른 메소드를 호출하기 전에 이를 설정해야 합니다.

서명:

export declare interface FirestoreSettings 

속성

FirestoreSettings.cacheSizeBytes

참고: 이 필드는 향후 주요 릴리스에서 더 이상 사용되지 않습니다. 캐시 크기 및 기타 캐시 구성을 지정하려면 대신 cache 필드를 사용하세요.

온디스크 데이터에 대한 대략적인 캐시 크기 임계값입니다. 캐시가 이 크기를 초과하면 Firestore는 최근에 사용되지 않은 데이터를 삭제하기 시작합니다. 크기는 캐시가 해당 크기 미만으로 유지된다는 것을 보장하지 않으며, 캐시가 지정된 크기를 초과하는 경우 정리가 시도된다는 점만 보장합니다.

기본값은 40MB입니다. 임계값은 최소 1MB로 설정되어야 하며 CACHE_SIZE_UNLIMITED 로 설정하여 가비지 수집을 비활성화할 수 있습니다.

서명:

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

장기 폴링을 사용해야 하는지 자동으로 감지하도록 SDK의 기본 전송(WebChannel)을 구성합니다. 이는 experimentalForceLongPolling 과 매우 유사합니다. , 필요한 경우에만 긴 폴링을 사용합니다.

2019년 도입 이후 기본값인 false 유지하다가 2023년 5월 Firebase JavaScript SDK v9.22.0에서는 이 설정의 기본값이 true 로 변경되었습니다. 즉, 이제 긴 폴링의 자동 감지가 기본적으로 활성화됩니다. 비활성화하려면 이 설정을 false 로 설정하세요. , GitHub 문제를 열어 장기 폴링 자동 감지를 비활성화하게 된 원인이 된 문제를 공유하세요.

Node.js 환경에서는 이 설정을 사용할 수 없습니다.

서명:

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

SDK의 기본 네트워크 전송(WebChannel)이 긴 폴링을 사용하도록 강제합니다. 백엔드의 각 응답은 백엔드가 데이터를 보낸 후 즉시 닫힙니다(기본적으로 백엔드에 보낼 데이터가 더 많은 경우 응답은 열린 상태로 유지됩니다). 이렇게 하면 트래픽을 무기한 잘못 버퍼링하는 특정 프록시, 바이러스 백신 소프트웨어 등과의 비호환성 문제를 방지할 수 있습니다. 하지만 이 옵션을 사용하면 성능이 약간 저하될 수 있습니다.

이 설정은 experimentalAutoDetectLongPolling 과 함께 사용할 수 없으며 향후 릴리스에서는 제거될 수 있습니다. 특정 네트워크 안정성 문제를 해결하기 위해 이를 사용하고 있다면 https://github.com/firebase/firebase-js-sdk/issues/1674에서 알려주세요.

Node.js 환경에서는 이 설정을 사용할 수 없습니다.

서명:

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

긴 폴링이 사용될 때 SDK의 기본 네트워크 전송(WebChannel)을 구성하는 옵션입니다.

이러한 옵션은 experimentalForceLongPolling true이거나 experimentalAutoDetectLongPolling true이고 자동 감지에서 긴 폴링이 필요하다고 판단한 경우에만 사용됩니다. 그렇지 않으면 이러한 옵션이 적용되지 않습니다.

서명:

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

연결할 호스트 이름입니다.

서명:

host?: string;

FirestoreSettings.ignoreUndefineProperties

객체 직렬화 중에 undefined 으로 설정된 중첩 속성을 건너뛸지 여부입니다. true 로 설정된 경우 , 이러한 속성은 건너뛰어 Firestore에 기록되지 않습니다. false 로 설정하거나 생략하는 경우 SDK는 undefined 유형의 속성을 발견할 때 예외를 발생시킵니다. .

서명:

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

SDK에서 사용하는 캐시를 지정합니다. 사용 가능한 옵션은 MemoryLocalCache 및 PersistentLocalCache 입니다. , 각각 다른 구성 옵션이 있습니다.

지정하지 않으면 기본적으로 MemoryLocalCache 사용됩니다.

참고: 이 필드와 cacheSizeBytes 동시에 설정하면 SDK 초기화 중에 예외가 발생합니다. 대신 FirestoreLocalCache 객체의 구성을 사용하여 캐시 크기를 지정하세요.

서명:

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

연결 시 SSL을 사용할지 여부입니다.

서명:

ssl?: boolean;