Cloud Firestore 인스턴스의 커스텀 구성을 지정합니다. 다른 메서드를 호출하기 전에 이를 설정해야 합니다.
서명:
export declare interface FirestoreSettings
속성
| 속성 | 유형 | 설명 |
|---|---|---|
| cacheSizeBytes | 숫자 | 참고: 이 필드는 향후 주요 버전에서 더 이상 사용되지 않습니다. 캐시 크기 및 기타 캐시 구성을 지정하려면 cache 필드를 대신 사용하세요.디스크 상의 데이터에 대한 대략적인 캐시 크기 임곗값입니다. 캐시가 이 크기 이상으로 커지면 Firestore에서 최근에 사용되지 않은 데이터를 삭제하기 시작합니다. 이 크기가 캐시가 지정된 크기 미만으로 유지된다는 보장은 없으며, 캐시가 지정된 크기를 초과하는 경우에만 삭제가 시도됩니다.기본값은 40MB입니다. 기준은 최소 1MB로 설정해야 하며 CACHE_SIZE_UNLIMITED로 설정하면 가비지 컬렉션을 사용 중지할 수 있습니다. |
| experimentalAutoDetectLongPolling | 부울 | 장기 폴링 사용 여부를 자동으로 감지하도록 SDK의 기본 전송 (WebChannel)을 구성합니다. experimentalForceLongPolling와 매우 유사하지만 필요한 경우에만 장기 폴링을 사용합니다.2019년 첫 출시 이후 false의 기본값이었던 이후 2023년 5월에 Firebase JavaScript SDK v9.22.0에서 이 설정의 기본값이 true로 변경되었습니다. 즉, 이제 긴 폴링 자동 감지가 기본적으로 사용 설정됩니다. 사용 중지하려면 이 설정을 false로 설정하고 GitHub 문제를 열어서 장기 폴링 자동 감지를 사용 중지하게 된 원인을 공유하세요.Node.js 환경에서는 이 설정을 사용할 수 없습니다. |
| experimentalForceLongPolling | 부울 | SDK의 기본 네트워크 전송 (WebChannel)이 장기 폴링을 사용하도록 강제합니다. 백엔드에서 보낸 각 응답은 백엔드에서 데이터를 보낸 직후에 종료됩니다. 기본적으로 백엔드에 더 많은 데이터가 있는 경우 응답이 열려 있는 상태로 유지됩니다. 이렇게 하면 트래픽을 무기한으로 잘못 버퍼링하는 특정 프록시, 바이러스 백신 소프트웨어 등과의 비호환성 문제를 방지할 수 있습니다. 이 옵션을 사용하면 성능 저하가 발생할 수 있습니다.이 설정은 experimentalAutoDetectLongPolling에서 사용할 수 없으며 향후 버전에서 삭제될 수 있습니다. 특정 네트워크 안정성 문제를 해결하는 데 이 도구를 사용하고 있다면 https://github.com/firebase/firebase-js-sdk/issues/1674 페이지에서 알려 주세요.Node.js 환경에서는 이 설정을 사용할 수 없습니다. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptions(실험용롱폴링옵션) | 장기 폴링 사용 시 SDK의 기본 네트워크 전송 (WebChannel)을 구성하는 옵션입니다.이러한 옵션은 experimentalForceLongPolling가 true이거나 experimentalAutoDetectLongPolling이 true이고 자동 감지에서 장기 폴링이 필요하다고 판단한 경우에만 사용됩니다. 그렇지 않으면 이 옵션이 적용되지 않습니다. |
| 호스트 | 문자열 | 연결할 호스트 이름입니다. |
| ignoreUndefinedProperties | 부울 | 객체 직렬화 중에 undefined로 설정된 중첩된 속성을 건너뛸지 여부입니다. true로 설정하면 이러한 속성을 건너뛰고 Firestore에 기록되지 않습니다. false로 설정하거나 생략하면 SDK에서 undefined 유형의 속성이 있을 때 예외가 발생합니다. |
| 로컬 캐시 | FirestoreLocalCache | SDK에서 사용하는 캐시를 지정합니다. 사용 가능한 옵션은 MemoryLocalCache 및 PersistentLocalCache이며 각각 구성 옵션이 다릅니다.지정하지 않으면 MemoryLocalCache가 기본적으로 사용됩니다.참고: 이 필드와 cacheSizeBytes를 동시에 설정하면 SDK 초기화 중에 예외가 발생합니다. 대신 FirestoreLocalCache 객체의 구성을 사용하여 캐시 크기를 지정합니다. |
| ssl | 부울 | 연결 시 SSL 사용 여부입니다. |
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;
Firestore 설정.호스트
연결할 호스트 이름입니다.
서명:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
객체 직렬화 중에 undefined로 설정된 중첩된 속성을 건너뛸지 여부입니다. true로 설정하면 이러한 속성을 건너뛰고 Firestore에 기록되지 않습니다. false로 설정하거나 생략하면 SDK에서 undefined 유형의 속성이 있을 때 예외가 발생합니다.
서명:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
SDK에서 사용하는 캐시를 지정합니다. 사용 가능한 옵션은 MemoryLocalCache 및 PersistentLocalCache이며 각각 구성 옵션이 다릅니다.
지정하지 않으면 MemoryLocalCache가 기본적으로 사용됩니다.
참고: 이 필드와 cacheSizeBytes를 동시에 설정하면 SDK 초기화 중에 예외가 발생합니다. 대신 FirestoreLocalCache 객체의 구성을 사용하여 캐시 크기를 지정합니다.
서명:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
연결 시 SSL 사용 여부입니다.
서명:
ssl?: boolean;