FirestoreSettings interface

Chỉ định cấu hình tùy chỉnh cho phiên bản Cloud Firestore của bạn. Bạn phải thiết lập những điều này trước khi gọi bất kỳ phương thức nào khác.

Chữ ký:

export declare interface FirestoreSettings 

Của cải

Tài sản Kiểu Sự miêu tả
bộ đệmSizeByte con số LƯU Ý: Trường này sẽ không được dùng nữa trong bản phát hành chính trong tương lai. Thay vào đó, hãy sử dụng trường cache để chỉ định kích thước bộ đệm và các cấu hình bộ đệm khác. Ngưỡng kích thước bộ đệm gần đúng cho dữ liệu trên đĩa. Nếu bộ đệm vượt quá kích thước này, Firestore sẽ bắt đầu xóa dữ liệu không được sử dụng gần đây. Kích thước không đảm bảo rằng bộ đệm sẽ ở dưới kích thước đó, chỉ có điều nếu bộ đệm vượt quá kích thước nhất định thì việc dọn dẹp sẽ được thực hiện. Giá trị mặc định là 40 MB. Ngưỡng phải được đặt thành ít nhất 1 MB và có thể được đặt thành CACHE_SIZE_UNLIMITED để tắt tính năng thu thập rác.
thử nghiệmAutoDetectLongPolling boolean Định cấu hình phương tiện truyền tải cơ bản của SDK (WebChannel) để tự động phát hiện xem có nên sử dụng phương pháp kiểm tra vòng dài hay không. Điều này rất giống với experimentalForceLongPolling nhưng chỉ sử dụng tính năng bỏ phiếu dài nếu được yêu cầu. Sau khi có giá trị mặc định là false kể từ khi ra mắt vào năm 2019, giá trị mặc định của tùy chọn cài đặt này đã được thay đổi thành true vào tháng 5 năm 2023 trong phiên bản 9.22.0 của SDK JavaScript Firebase. Nghĩa là, tính năng tự động phát hiện bỏ phiếu dài hiện được bật theo mặc định. Để tắt tính năng này, hãy đặt cài đặt này thành false và vui lòng mở vấn đề GitHub để chia sẻ các vấn đề khiến bạn vô hiệu hóa tính năng tự động phát hiện bỏ phiếu dài. Không thể sử dụng cài đặt này trong môi trường Node.js.
thử nghiệmForceLongPolling boolean Buộc truyền tải mạng cơ bản của SDK (WebChannel) sử dụng tính năng kiểm tra vòng dài. Mỗi phản hồi từ phần phụ trợ sẽ bị đóng ngay sau khi phần phụ trợ gửi dữ liệu (theo mặc định các phản hồi được giữ mở trong trường hợp phần phụ trợ có nhiều dữ liệu hơn để gửi). Điều này tránh các vấn đề không tương thích với một số proxy, phần mềm chống vi-rút, v.v. đệm lưu lượng truy cập không chính xác vô thời hạn. Tuy nhiên, việc sử dụng tùy chọn này sẽ gây ra một số suy giảm hiệu suất. Không thể sử dụng cài đặt này với experimentalAutoDetectLongPolling và có thể bị xóa trong bản phát hành trong tương lai. Nếu bạn thấy mình đang sử dụng nó để giải quyết một vấn đề về độ tin cậy của mạng cụ thể, vui lòng cho chúng tôi biết về vấn đề đó trong https://github.com/firebase/firebase-js-sdk/issues/1674. Không thể sử dụng cài đặt này trong môi trường Node.js.
thử nghiệmLongPollingOptions Thử nghiệmLongPollingOptions Các tùy chọn định cấu hình truyền tải mạng cơ bản của SDK (WebChannel) khi sử dụng tính năng kiểm tra vòng dài. Các tùy chọn này chỉ được sử dụng nếu experimentalForceLongPolling đúng hoặc nếu experimentalAutoDetectLongPolling đúng và tính năng tự động phát hiện đã xác định rằng cần phải bỏ phiếu dài. Nếu không, các tùy chọn này không có hiệu lực.
chủ nhà sợi dây Tên máy chủ để kết nối.
bỏ quaUnd xác địnhProperties boolean Có bỏ qua các thuộc tính lồng nhau được đặt thành undefined trong quá trình tuần tự hóa đối tượng hay không. Nếu được đặt thành true , các thuộc tính này sẽ bị bỏ qua và không được ghi vào Firestore. Nếu được đặt thành false hoặc bị bỏ qua, SDK sẽ đưa ra một ngoại lệ khi gặp thuộc tính thuộc loại undefined .
bộ đệm cục bộ FirestoreLocalCache Chỉ định bộ đệm được SDK sử dụng. Các tùy chọn có sẵn là MemoryLocalCachePersistentLocalCache , mỗi tùy chọn có các tùy chọn cấu hình khác nhau. Khi không được chỉ định, MemoryLocalCache sẽ được sử dụng theo mặc định. LƯU Ý: việc đặt trường này và cacheSizeBytes cùng lúc sẽ đưa ra ngoại lệ trong quá trình khởi tạo SDK. Thay vào đó, hãy sử dụng cấu hình trong đối tượng FirestoreLocalCache để chỉ định kích thước bộ đệm.
ssl boolean Có sử dụng SSL khi kết nối hay không.

FirestoreSettings.cacheSizeBytes

LƯU Ý: Trường này sẽ không được dùng nữa trong bản phát hành chính trong tương lai. Thay vào đó, hãy sử dụng trường cache để chỉ định kích thước bộ đệm và các cấu hình bộ đệm khác.

Ngưỡng kích thước bộ đệm gần đúng cho dữ liệu trên đĩa. Nếu bộ đệm vượt quá kích thước này, Firestore sẽ bắt đầu xóa dữ liệu không được sử dụng gần đây. Kích thước không đảm bảo rằng bộ đệm sẽ ở dưới kích thước đó, chỉ có điều nếu bộ đệm vượt quá kích thước nhất định thì việc dọn dẹp sẽ được thực hiện.

Giá trị mặc định là 40 MB. Ngưỡng phải được đặt thành ít nhất 1 MB và có thể được đặt thành CACHE_SIZE_UNLIMITED để tắt tính năng thu thập rác.

Chữ ký:

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

Định cấu hình phương tiện truyền tải cơ bản của SDK (WebChannel) để tự động phát hiện xem có nên sử dụng phương pháp kiểm tra vòng dài hay không. Điều này rất giống với experimentalForceLongPolling , nhưng chỉ sử dụng bỏ phiếu dài nếu được yêu cầu.

Sau khi có giá trị mặc định là false kể từ khi ra mắt vào năm 2019, giá trị mặc định của tùy chọn cài đặt này đã được thay đổi thành true vào tháng 5 năm 2023 trong phiên bản 9.22.0 của SDK JavaScript Firebase. Nghĩa là, tính năng tự động phát hiện bỏ phiếu dài hiện được bật theo mặc định. Để tắt nó, hãy đặt cài đặt này thành false và vui lòng mở vấn đề GitHub để chia sẻ các vấn đề khiến bạn vô hiệu hóa tính năng tự động phát hiện bỏ phiếu dài.

Không thể sử dụng cài đặt này trong môi trường Node.js.

Chữ ký:

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

Buộc truyền tải mạng cơ bản của SDK (WebChannel) sử dụng tính năng kiểm tra vòng dài. Mỗi phản hồi từ phần phụ trợ sẽ bị đóng ngay sau khi phần phụ trợ gửi dữ liệu (theo mặc định các phản hồi được giữ mở trong trường hợp phần phụ trợ có nhiều dữ liệu hơn để gửi). Điều này tránh các vấn đề không tương thích với một số proxy, phần mềm chống vi-rút, v.v. đệm lưu lượng truy cập không chính xác vô thời hạn. Tuy nhiên, việc sử dụng tùy chọn này sẽ gây ra một số suy giảm hiệu suất.

Không thể sử dụng cài đặt này với experimentalAutoDetectLongPolling và có thể bị xóa trong bản phát hành trong tương lai. Nếu bạn thấy mình đang sử dụng nó để giải quyết một vấn đề về độ tin cậy của mạng cụ thể, vui lòng cho chúng tôi biết về vấn đề đó trong https://github.com/firebase/firebase-js-sdk/issues/1674.

Không thể sử dụng cài đặt này trong môi trường Node.js.

Chữ ký:

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

Các tùy chọn định cấu hình truyền tải mạng cơ bản của SDK (WebChannel) khi sử dụng tính năng kiểm tra vòng dài.

Các tùy chọn này chỉ được sử dụng nếu experimentalForceLongPolling đúng hoặc nếu experimentalAutoDetectLongPolling đúng và tính năng tự động phát hiện đã xác định rằng cần phải bỏ phiếu dài. Nếu không, các tùy chọn này không có hiệu lực.

Chữ ký:

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

Tên máy chủ để kết nối.

Chữ ký:

host?: string;

FirestoreSettings.ignoreUnd xác địnhProperties

Có bỏ qua các thuộc tính lồng nhau được đặt thành undefined trong quá trình tuần tự hóa đối tượng hay không. Nếu được đặt thành true , các thuộc tính này sẽ bị bỏ qua và không được ghi vào Firestore. Nếu được đặt thành false hoặc bị bỏ qua, SDK sẽ đưa ra một ngoại lệ khi gặp thuộc tính thuộc loại undefined .

Chữ ký:

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

Chỉ định bộ đệm được SDK sử dụng. Các tùy chọn có sẵn là MemoryLocalCachePersistentLocalCache , mỗi loại có các tùy chọn cấu hình khác nhau.

Khi không được chỉ định, MemoryLocalCache sẽ được sử dụng theo mặc định.

LƯU Ý: việc đặt trường này và cacheSizeBytes cùng lúc sẽ đưa ra ngoại lệ trong quá trình khởi tạo SDK. Thay vào đó, hãy sử dụng cấu hình trong đối tượng FirestoreLocalCache để chỉ định kích thước bộ đệm.

Chữ ký:

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

Có sử dụng SSL khi kết nối hay không.

Chữ ký:

ssl?: boolean;