@firebase/firestore

Fonksiyonlar

İşlev Tanım
işlev(uygulama, ...)
getFirestore(uygulama) Sağlanan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
getFirestore(uygulama, veritabanı kimliği) (BETA) Sağlanan FirebaseApp ile ilişkili mevcut adlandırılmış Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
startupizeFirestore(uygulama, ayarlar, veritabanı kimliği) Sağlanan ayarlarla yeni bir Firestore örneğini başlatır. Yalnızca getFirestore() dahil herhangi bir işlevden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. .
fonksiyon(ateş deposu, ...)
clearIndexedDbPersistence(firestore) Kalıcı depolamayı temizler. Bu, bekleyen yazma işlemlerini ve önbelleğe alınan belgeleri içerir. Firestore örneği başlatılmadığında (uygulama sonlandırıldıktan sonra veya uygulama ilk başlatıldığında) çağrılmalıdır. Başlangıçta, bu işlevin diğer işlevlerden ( initializeFirestore() veya getFirestore() dışında) önce çağrılması gerekir. )). Firestore örneği hala çalışıyorsa söz, failed-precondition hata koduyla reddedilecektir. Not: clearIndexedDbPersistence() öncelikli olarak Cloud Firestore kullanan güvenilir testlerin yazılmasına yardımcı olmayı amaçlamaktadır. Mevcut verileri bırakmak için etkili bir mekanizma kullanır ancak önbelleğe alınmış verilerin üzerine güvenli bir şekilde yazmaya veya başka şekilde kurtarılamaz hale getirmeye çalışmaz. Kullanıcı oturumları arasında önbelleğe alınmış verilerin ifşa edilmesine duyarlı uygulamalar için kalıcılığın hiçbir şekilde etkinleştirilmemesini önemle öneririz.
koleksiyon(firestore, yol, yolSegmentleri) Belirtilen mutlak yoldaki koleksiyona başvuran bir CollectionReference örneği alır.
koleksiyonGrubu(ateş deposu, koleksiyon kimliği) Belirtilen collectionId ile bir koleksiyonda veya alt koleksiyonda bulunan veritabanındaki tüm belgeleri içeren yeni bir Query örneği oluşturur ve döndürür.
connectFirestoreEmulator(firestore, ana makine, bağlantı noktası, seçenekler) Cloud Firestore emülatörüyle iletişim kurmak için bu örneği değiştirin. Not: Bu örnek herhangi bir işlem yapmak için kullanılmadan önce bunun çağrılması gerekir.
Network'ü devre dışı bırak (firestore) Bu örnek için ağ kullanımını devre dışı bırakır. EnableNetwork() aracılığıyla yeniden etkinleştirilebilir . Ağ devre dışıyken, tüm anlık görüntü dinleyicileri, getDoc() veya getDocs() çağrıları önbellekten sonuçları döndürecek ve tüm yazma işlemleri, ağ geri yüklenene kadar kuyruğa alınacaktır.
doc(firestore, yol, yolSegmentleri) Belirtilen mutlak yoldaki belgeye başvuran bir DocumentReference örneğini alır.
activeIndexedDbPersistence(firestore, persistenceSettings) Mümkünse kalıcı depolamayı etkinleştirmeye çalışır. Başarısızlık durumunda, enableIndexedDbPersistence() sözü reddedecek veya bir istisna oluşturacaktır. Bunun başarısız olmasının birkaç nedeni vardır ve bunlar, hatanın üzerindeki code tanımlanabilir. * başarısız önkoşul: Uygulama zaten başka bir tarayıcı sekmesinde açık. * uygulanmadı: Tarayıcı çevrimdışı kalıcılık uygulamasıyla uyumlu değil. Bir arızadan sonra bile Firestore örneğinin kullanılabilir durumda kalacağını ancak çevrimdışı kalıcılığın devre dışı bırakılacağını unutmayın. Not: enableIndexedDbPersistence() diğer işlevlerden önce çağrılmalıdır ( initializeFirestore() dışında) , getFirestore() veya clearIndexedDbPersistence() . Kalıcılık Node.js ortamında kullanılamaz.
activeMultiTabIndexedDbPersistence(firestore) Mümkünse, çok sekmeli kalıcı depolamayı etkinleştirmeye çalışır. Tüm sekmelerde etkinleştirilirse tüm işlemler, sorguların ortak yürütülmesi ve tüm bağlı örneklerde gecikme telafili yerel belge güncellemeleri dahil olmak üzere yerel kalıcılığa erişimi paylaşır. Başarısızlık durumunda, enableMultiTabIndexedDbPersistence() sözü reddedecek veya bir istisna oluşturacaktır. Bunun başarısız olmasının birkaç nedeni vardır ve bunlar, hatanın üzerindeki code tanımlanabilir. * başarısız önkoşul: Uygulama zaten başka bir tarayıcı sekmesinde açık ve çoklu sekme etkin değil. * uygulanmadı: Tarayıcı çevrimdışı kalıcılık uygulamasıyla uyumlu değil. Bir arızadan sonra bile Firestore örneğinin kullanılabilir durumda kalacağını ancak çevrimdışı kalıcılığın devre dışı bırakılacağını unutmayın.
EnableNetwork(firestore) DisableNetwork() çağrısından sonra bu Firestore örneği için ağın kullanımını yeniden etkinleştirir .
getPersistentCacheIndexManager(firestore) Verilen Firestore nesnesi tarafından kullanılan PersistentCache Dizin Yöneticisini döndürür. PersistentCacheIndexManager örneği veya yerel kalıcı depolama kullanımda değilse null .
loadBundle(firestore, bundleData) Yerel önbelleğe bir Firestore paketi yükler.
NamedQuery(firestore, ad) Verilen adla tanımlanan yerel önbellekten bir Firestore Sorgusunu okur. Adlandırılmış sorgular sunucu tarafında paketler halinde paketlenir (sonuçlanan belgelerle birlikte) ve loadBundle kullanılarak yerel önbelleğe yüklenir. Yerel önbelleğe girdikten sonra, ada göre bir Sorgu çıkarmak için bu yöntemi kullanın.
onSnapshotsInSync(ateş deposu, gözlemci) Senkronize anlık görüntüler olayı için bir dinleyici ekler. Senkronize anlık görüntüler olayı, sunucu tarafından oluşturulan tek bir değişiklik birden fazla dinleyiciyi etkilese bile, belirli bir değişiklikten etkilenen tüm dinleyicilerin tetiklendiğini gösterir. NOT: Senkronize anlık görüntüler olayı yalnızca dinleyicilerin birbirleriyle senkronize olduğunu gösterir ancak bu anlık görüntülerin sunucuyla senkronize olup olmadığıyla ilgili değildir. Bir anlık görüntünün önbellekten mi yoksa sunucudan mı geldiğini belirlemek için bireysel dinleyicilerde SnapshotMetadata'yı kullanın.
onSnapshotsInSync(firestore, onSync) Senkronize anlık görüntüler olayı için bir dinleyici ekler. Senkronize anlık görüntüler olayı, sunucu tarafından oluşturulan tek bir değişiklik birden fazla dinleyiciyi etkilese bile, belirli bir değişiklikten etkilenen tüm dinleyicilerin tetiklendiğini gösterir. NOT: Senkronize anlık görüntüler olayı yalnızca dinleyicilerin birbirleriyle senkronize olduğunu gösterir ancak bu anlık görüntülerin sunucuyla senkronize olup olmadığıyla ilgili değildir. Bir anlık görüntünün önbellekten mi yoksa sunucudan mı geldiğini belirlemek için bireysel dinleyicilerde SnapshotMetadata kullanın.
runTransaction(firestore, updateFunction, seçenekler) Verilen updateFunction çalıştırır ve ardından işlem içinde uygulanan değişiklikleri gerçekleştirmeye çalışır. İşlem içinde okunan herhangi bir belge değiştiyse Cloud Firestore, updateFunction öğesini yeniden dener. 5 denemeden sonra taahhütte bulunulamazsa işlem başarısız olur. Tek bir işlemde izin verilen maksimum yazma sayısı 500'dür.
setIndexConfiguration(firestore, yapılandırma) (BETA) Yerel sorgu yürütme için dizin oluşturmayı yapılandırır. Önceki dizin yapılandırmaları geçersiz kılınır. Dizin yapılandırması devam ettirildiğinde Promise çözülür. Dizin girişlerinin kendisi eşzamansız olarak oluşturulur. İndeksler henüz mevcut olmasa bile indeksleme gerektiren sorguları kullanmaya devam edebilirsiniz. Dizin girişleri yazıldıktan sonra sorgu yürütme otomatik olarak dizini kullanmaya başlayacaktır. Dizinler yalnızca IndexedDb kalıcılığıyla desteklenir. IndexedDb etkinleştirilmemişse tüm dizin yapılandırmaları göz ardı edilir.
setIndexConfiguration(firestore, json) (BETA) Yerel sorgu yürütme için dizin oluşturmayı yapılandırır. Önceki dizin yapılandırmaları geçersiz kılınır. Dizin yapılandırması devam ettirildiğinde Promise çözülür. Dizin girişlerinin kendisi eşzamansız olarak oluşturulur. İndeksler henüz mevcut olmasa bile indeksleme gerektiren sorguları kullanmaya devam edebilirsiniz. Dizin girişleri yazıldıktan sonra sorgu yürütme otomatik olarak dizini kullanmaya başlayacaktır. Dizinler yalnızca IndexedDb kalıcılığıyla desteklenir. Bir dizin yapılandırmasını ayarlamadan önce, enableIndexedDbPersistence() veya enableMultiTabIndexedDbPersistence() öğesini çağırın. IndexedDb etkinleştirilmemişse tüm dizin yapılandırmaları göz ardı edilir. Yöntem, Firebase CLI ( firebase firestore:indexes ) tarafından dışa aktarılan JSON biçimini kabul eder. JSON formatı geçersizse bu yöntem bir hata atar.
sonlandır(firestore) Sağlanan Firestore örneğini sonlandırır. terminate() çağrıldıktan sonra yalnızca clearIndexedDbPersistence() işlevi kullanılabilir. Başka herhangi bir işlev FirestoreError atacaktır. Fesih sonrasında yeniden başlatmak için getFirestore() ile yeni bir FirebaseFirestore örneği oluşturun. . Fesih, bekleyen herhangi bir yazma işlemini iptal etmez ve sunucudan yanıt bekleyen herhangi bir söz çözümlenmez. Kalıcılığı etkinleştirdiyseniz, bu örneği bir sonraki başlatışınızda, bu yazma işlemlerini sunucuya göndermeye devam edecektir. Not: Normal koşullar altında, terminate() çağrılması gerekli değildir. Bu işlev yalnızca bu örneği tüm kaynaklarını serbest bırakmaya zorlamak istediğinizde veya test çalıştırmaları arasında tüm yerel durumun yok edildiğinden emin olmak için clearIndexedDbPersistence() ile birlikte kullanışlıdır.
waitForPendingWrites(firestore) Aktif kullanıcı için şu anda bekleyen tüm yazma işlemlerinin arka uç tarafından onaylanmasını bekler. Geri gönderilen söz, bekleyen yazma işlemi yoksa hemen çözümlenir. Aksi takdirde, söz daha önce verilen tüm yazma işlemlerini (önceki uygulama oturumunda yazılanlar dahil) bekler, ancak işlev çağrıldıktan sonra eklenen yazma işlemlerini beklemez. Ek yazma işlemlerini beklemek istiyorsanız waitForPendingWrites() öğesini tekrar arayın. Bekleyen waitForPendingWrites() vaatleri, kullanıcı değişiklikleri sırasında reddedilir.
writeBatch(firestore) Tek bir atomik işlem olarak birden çok yazma işlemi gerçekleştirmek için kullanılan bir yazma toplu işlemi oluşturur. Tek bir WriteBatch'te izin verilen maksimum yazma sayısı 500'dür. İşlemlerin aksine, yazma grupları çevrimdışı olarak kalıcıdır ve bu nedenle yazma işlemlerinizi okunan verilere göre koşullandırmanız gerekmediğinde tercih edilir.
işlev()
saymak() Bir sorgunun sonuç kümesindeki belge sayısını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.
deleteField() Bir alanı silinmek üzere işaretlemek için updateDoc() veya setDoc() ile {merge: true} ile kullanılacak bir sentinel döndürür.
belgeKimliği() Bir belgenin kimliğine başvurmak için özel bir nöbetçi FieldPath döndürür. Sorgularda belge kimliğine göre sıralamak veya filtrelemek için kullanılabilir.
getFirestore() Varsayılan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
MemoryEagerGarbageCollector() MemoryEagerGarbageCollector örneğini oluşturur. Bu aynı zamanda aksi açıkça belirtilmediği sürece varsayılan çöp toplayıcıdır.
persistantMultipleTabManager() PersistentMultipleTabManager örneğini oluşturur.
sunucuTimestamp() Yazılı verilere sunucu tarafından oluşturulan bir zaman damgasını dahil etmek için setDoc() veya updateDoc() ile kullanılan bir sentinel döndürür.
işlev (veritabanı kimliği, ...)
getFirestore(veritabanı kimliği) (BETA) Varsayılan FirebaseApp ile ilişkili mevcut adlandırılmış Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
fonksiyon(elemanlar, ...)
arrayRemove(öğeler) setDoc() ile kullanılabilecek veya sunucuya, sunucuda zaten var olan herhangi bir dizi değerinden verilen öğeleri kaldırmasını söyleyen özel bir değer döndürür. Belirtilen her öğenin tüm örnekleri diziden kaldırılacaktır. Değiştirilen alan zaten bir dizi değilse, üzerine boş bir dizi yazılacaktır.
diziBirliği(öğeler) Sunucuya, verilen öğeleri sunucuda zaten var olan herhangi bir dizi değeriyle birleştirmesini söyleyen setDoc() veya updateDoc() ile kullanılabilecek özel bir değer döndürür. Dizide halihazırda mevcut olmayan her belirtilen öğe sonuna eklenecektir. Değiştirilen alan zaten bir dizi değilse, tam olarak belirtilen öğeleri içeren bir dizi onun üzerine yazılacaktır.
fonksiyon(alan, ...)
ortalama(alan) Bir sorgunun sonuç kümesindeki bir dizi belge üzerinden belirli bir alanın ortalamasını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.
toplam(alan) Bir sorgunun sonuç kümesindeki bir dizi belge üzerinde belirtilen alanın toplamını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.
fonksiyon(fieldPath, ...)
orderBy(fieldPath, DirectionStr) Sorgu sonucunu belirtilen alana göre, isteğe bağlı olarak artan yerine azalan sırada sıralayan bir QueryOrderByConstraint oluşturur. Not: Belirtilen alanı içermeyen belgeler sorgu sonucunda yer almayacaktır.
nerede(fieldPath, opStr, değer) Belgelerin belirtilen alanı içermesi gerektiğini ve değerin sağlanan ilişki kısıtlamasını karşılamasını zorunlu kılan bir QueryFieldFilterConstraint oluşturur.
fonksiyon(fieldValues, ...)
endAt(fieldValues) Sonuç kümesini, sorgu sırasına göre sağlanan alanlarda bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir.
endBefore(fieldValues) Sonuç kümesini, sorgu sırasına göre sağlanan alanlardan önce bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir.
startAfter(fieldValues) Sonuç kümesini, sorgu sırasına göre sağlanan alanlardan sonra başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir.
startAt(fieldValues) Sonuç kümesini, sorgu sırasına göre sağlanan alanlardan başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir.
fonksiyon(indexManager, ...)
deleteAllPersistentCacheIndexes(indexManager) Tüm kalıcı önbellek dizinlerini kaldırır. Lütfen bu işlevin setIndexConfiguration() tarafından oluşturulan ve kullanımdan kaldırılan dizinleri de sileceğini unutmayın.
devre dışı bırakmaPersistentCacheIndexAutoCreation(indexManager) Yerel sorgu yürütme için otomatik olarak kalıcı önbellek dizinleri oluşturmayı durdurur. enablePersistentCacheIndexAutoCreation() çağrılarak oluşturulan dizinler hala etkili olur.
activePersistentCacheIndexAutoCreation(indexManager) SDK, önbellek dizinlerinin performansı artırmaya yardımcı olabileceğine inandığında, SDK'nın yerel sorgu yürütmesi için otomatik olarak kalıcı önbellek dizinleri oluşturmasını sağlar. Bu özellik varsayılan olarak devredışı bırakılmıştır.
fonksiyon(sol, ...)
agregaFieldEqual(sol, sağ) İki 'AggregateField'ı karşılaştırır ' Eşitlik örnekleri.
ToplamaQuerySnapshotEqual(sol, sağ) Eşitlik açısından iki AggregateQuerySnapshot örneğini karşılaştırır. İki AggregateQuerySnapshot örneği, eşit ve aynı verileri karşılaştıran temel sorgulara sahipse "eşit" olarak kabul edilir.
queryEqual(sol, sağ) Sağlanan sorgular aynı koleksiyona işaret ediyorsa ve aynı kısıtlamaları uyguluyorsa true değerini döndürür.
refEqual(sol, sağ) Sağlanan referanslar eşitse true değerini döndürür.
anlık görüntüEşit(sol, sağ) Sağlanan anlık görüntüler eşitse true değerini döndürür.
fonksiyon(limit, ...)
limit(limit) Yalnızca ilk eşleşen belgeleri döndüren bir QueryLimitConstraint oluşturur.
limitToLast(sınır) Yalnızca son eşleşen belgeleri döndüren bir QueryLimitConstraint oluşturur. limitToLast sorguları için en az bir orderBy yan tümcesi belirtmeniz gerekir, aksi takdirde yürütme sırasında bir istisna atılır.
fonksiyon(logLevel, ...)
setLogLevel(logLevel) Cloud Firestore günlüklerinin ayrıntı düzeyini ayarlar (hata ayıklama, hata veya sessiz).
fonksiyon(n, ...)
artış(n) setDoc() veya updateDoc() ile kullanılabilecek, sunucuya alanın geçerli değerini verilen değer kadar artırmasını söyleyen özel bir değer döndürür. İşlenen veya geçerli alan değeri kayan nokta hassasiyetini kullanıyorsa, tüm aritmetik IEEE 754 semantiğini takip eder. Her iki değer de tamsayıysa, JavaScript'in güvenli sayı aralığının ( Number.MIN_SAFE_INTEGER - Number.MAX_SAFE_INTEGER arası) dışındaki değerler de hassasiyet kaybına maruz kalır. Ayrıca, Firestore arka ucu tarafından işlendikten sonra tüm tamsayı işlemleri -2^63 ile 2^63-1 arasında sınırlanır. Geçerli alan değeri number türünde değilse veya alan henüz mevcut değilse, dönüşüm, alanı verilen değere ayarlar.
işlev (sorgu, ...)
getAggregateFromServer(sorgu,gregaSpec) Belgeleri fiili olarak indirmeden, verilen sorgunun sonuç kümesindeki belgeler üzerinden belirtilen toplamaları hesaplar. Toplamaları gerçekleştirmek için bu işlevin kullanılması verimlidir çünkü belgelerin verileri değil yalnızca nihai toplama değerleri indirilir. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda (binlerce belge) belgelerin birleştirilmesini gerçekleştirebilir. Sunucudan alınan sonuç, herhangi bir yerel durum dikkate alınmaksızın değiştirilmeden sunulur. Yani, yerel önbellekteki belgeler dikkate alınmaz ve henüz sunucuyla senkronize edilmemiş yerel değişiklikler de dikkate alınmaz. Varsa daha önce indirilen sonuçlar kullanılmaz. Bu işlevin her çağrılması zorunlu olarak sunucuya bir gidiş-dönüş yolculuğu gerektirir.
getCountFromServer(sorgu) Belgeleri gerçekte indirmeden, verilen sorgunun sonuç kümesindeki belge sayısını hesaplar. Belgeleri saymak için bu işlevin kullanılması verimlidir çünkü belgelerin verileri değil yalnızca son sayım indirilir. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda (binlerce belge) belgeleri sayabilir. Sunucudan alınan sonuç, herhangi bir yerel durum dikkate alınmaksızın değiştirilmeden sunulur. Yani, yerel önbellekteki belgeler dikkate alınmaz ve henüz sunucuyla senkronize edilmemiş yerel değişiklikler de dikkate alınmaz. Varsa daha önce indirilen sonuçlar kullanılmaz. Bu işlevin her çağrılması zorunlu olarak sunucuya bir gidiş-dönüş yolculuğu gerektirir.
getDocs(sorgu) Sorguyu yürütür ve sonuçları QuerySnapshot olarak döndürür. Not: getDocs() mümkün olduğunda sunucudan veri bekleyerek güncel veriler sağlamaya çalışır, ancak önbelleğe alınmış verileri döndürebilir veya çevrimdışıysanız ve sunucuya ulaşılamıyorsa başarısız olabilir. Bu davranışı belirtmek için getDocsFromCache() veya getDocsFromServer()' ı çağırın. .
getDocsFromCache(sorgu) Sorguyu yürütür ve sonuçları önbellekten bir QuerySnapshot olarak döndürür. Sorguyla eşleşen hiçbir belge şu anda önbelleğe alınmamışsa boş bir sonuç kümesi döndürür.
getDocsFromServer(sorgu) Sorguyu yürütür ve sonuçları sunucudan bir QuerySnapshot olarak döndürür. Ağ kullanılamıyorsa hata döndürür.
onSnapshot(sorgu, gözlemci) QuerySnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. onSnapshot çağrıldığında döndürülen işlev çağrılarak dinleyici iptal edilebilir. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
onSnapshot(sorgu, seçenekler, gözlemci) QuerySnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. onSnapshot çağrıldığında döndürülen işlev çağrılarak dinleyici iptal edilebilir. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
onSnapshot(sorgu, onSonraki, onError, onCompletion) QuerySnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. onSnapshot çağrıldığında döndürülen işlev çağrılarak dinleyici iptal edilebilir. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
onSnapshot(sorgu, seçenekler, onNext, onError, onCompletion) QuerySnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. onSnapshot çağrıldığında döndürülen işlev çağrılarak dinleyici iptal edilebilir. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
sorgu(sorgu, kompozitFilter, queryConstraints) Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.
sorgu(sorgu, queryConstraints) Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.
fonksiyon(queryConstraints, ...)
ve(sorguKısıtlamaları) Verilen filtre kısıtlamalarının birleşimi olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir bağlantı filtresi, verilen tüm filtreleri karşılıyorsa bir belgeyi içerir.
veya(sorguKısıtlamaları) Verilen filtre kısıtlamalarının bir parçası olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir ayırma filtresi, verilen filtrelerden herhangi birini karşılıyorsa bir belgeyi içerir.
fonksiyon(referans, ...)
addDoc(başvuru, veri) Belirtilen CollectionReference , verilen verilerle yeni bir belge ekleyin ve bu belgeye otomatik olarak bir belge kimliği atayın.
koleksiyon(referans, yol, yolSegmentleri) Belirtilen göreli yoldaki reference alt koleksiyonuna başvuran bir CollectionReference örneği alır.
koleksiyon(referans, yol, yolSegmentleri) Belirtilen göreli yoldaki reference alt koleksiyonuna başvuran bir CollectionReference örneği alır.
deleteDoc(referans) Belirtilen DocumentReference tarafından başvurulan belgeyi siler.
doc(referans, yol, yolSegmentleri) Belirtilen göreli yolda reference içindeki bir belgeye başvuran bir DocumentReference örneğini alır. Hiçbir yol belirtilmezse, döndürülen DocumentReference için otomatik olarak oluşturulan benzersiz bir kimlik kullanılacaktır.
doc(referans, yol, yolSegmentleri) Belirtilen göreli yolda reference içindeki bir belgeye başvuran bir DocumentReference örneğini alır.
getDoc(referans) Bu DocumentReference tarafından başvurulan belgeyi okur. Not: getDoc() mümkün olduğunda sunucudan veri bekleyerek güncel veri sağlamaya çalışır, ancak önbelleğe alınmış verileri döndürebilir veya çevrimdışıysanız ve sunucuya ulaşılamıyorsa başarısız olabilir. Bu davranışı belirtmek için getDocFromCache() veya getDocFromServer()' ı çağırın. .
getDocFromCache(referans) Bu DocumentReference tarafından başvurulan belgeyi önbellekten okur. Belge şu anda önbelleğe alınmamışsa bir hata döndürür.
getDocFromServer(referans) Bu DocumentReference tarafından başvurulan belgeyi sunucudan okur. Ağ kullanılamıyorsa hata döndürür.
onSnapshot(başvuru, gözlemci) DocumentSnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
onSnapshot(başvuru, seçenekler, gözlemci) DocumentSnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
onSnapshot(referans, onSonraki, onError, onCompletion) DocumentSnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
onSnapshot(referans, seçenekler, onNext, onError, onCompletion) DocumentSnapshot olayları için bir dinleyici ekler. Bireysel onNext ve onError geri çağırmalarını iletebilir veya next ve error geri aramalarıyla tek bir gözlemci nesnesini iletebilirsiniz. NOT: onCompletion geri arama sağlanabilse de, anlık görüntü akışı hiç bitmediği için hiçbir zaman çağrılmaz.
setDoc(başvuru, veri) Bu DocumentReference tarafından başvurulan belgeye yazar. Belge henüz mevcut değilse oluşturulacaktır.
setDoc(başvuru, veri, seçenekler) Belirtilen DocumentReference tarafından başvurulan belgeye yazar. Belge henüz mevcut değilse oluşturulacaktır. merge veya mergeFields sağlarsanız sağlanan veriler mevcut bir belgeyle birleştirilebilir.
updateDoc(referans, veri) Belirtilen DocumentReference tarafından başvurulan belgedeki alanları günceller. Mevcut olmayan bir belgeye uygulandığında güncelleme başarısız olur.
updateDoc(referans, alan, değer, moreFieldsAndValues) Belirtilen DocumentReference tarafından başvurulan belgedeki alanları günceller Güncelleme, mevcut olmayan bir belgeye uygulanırsa başarısız olur. İç içe geçmiş alanlar, noktalarla ayrılmış alan yolu dizeleri sağlanarak veya FieldPath nesneleri sağlanarak güncellenebilir.
fonksiyon(ayarlar, ...)
MemoryLocalCache(ayarlar) MemoryLocalCache örneğini oluşturur. Örnek, SDK'ya hangi önbellek katmanının kullanılacağını bildirmek için FirestoreSettings.cache olarak ayarlanabilir.
MemoryLruGarbageCollector(ayarlar) MemoryLruGarbageCollector örneğini oluşturur. Ayar parametresinin bir parçası olarak bir hedef boyut belirtilebilir. Önbellek boyutu verilen boyutu aştığında toplayıcı belgeleri silmeye başlayacaktır. Varsayılan önbellek boyutu 40 MB'dir (40 * 1024 * 1024 bayt).
kalıcıLocalCache(ayarlar) PersistentLocalCache örneğini oluşturur. Örnek, SDK'ya hangi önbellek katmanının kullanılacağını bildirmek için FirestoreSettings.cache olarak ayarlanabilir. Kalıcı önbellek Node.js ortamında kullanılamaz.
persistantSingleTabManager(ayarlar) PersistentSingleTabManager örneğini oluşturur.
işlev(anlık görüntü, ...)
endAt(anlık görüntü) Sonuç kümesini sağlanan belgede (dahil) bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu sorgunun sırasına göredir. Belge, sorgunun orderBy'sinde sağlanan alanların tümünü içermelidir.
endBefore(anlık görüntü) Sonuç kümesini sağlanan belgeden (hariç) önce bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu sorgunun sırasına göredir. Belge, sorgunun orderBy'sinde sağlanan alanların tümünü içermelidir.
startAfter(anlık görüntü) Sağlanan belgeden (hariç) sonra başlayacak şekilde sonuç kümesini değiştiren bir QueryStartAtConstraint oluşturur. Başlangıç ​​konumu sorgunun sırasına göredir. Belge, sorgunun orderBy'sinde sağlanan alanların tümünü içermelidir.
startAt(anlık görüntü) Sağlanan belgede (dahil) başlayacak şekilde sonuç kümesini değiştiren bir QueryStartAtConstraint oluşturur. Başlangıç ​​konumu sorgunun sırasına göredir. Belge, bu sorgunun orderBy sağlanan alanların tümünü içermelidir.

Sınıflar

Sınıf Tanım
Toplam Alan Firestore tarafından gerçekleştirilebilecek bir toplamayı temsil eder.
Toplu Sorgu Anlık Görüntüsü Toplama sorgusu yürütmenin sonuçları.
Bayt Bir bayt dizisini temsil eden değişmez bir nesne.
KoleksiyonReferans CollectionReference nesnesi, belge eklemek, belge referansları almak ve belgeleri sorgulamak ( query() kullanarak) için kullanılabilir. ).
BelgeReferansı DocumentReference Firestore veritabanındaki bir belge konumunu ifade eder ve konumu yazmak, okumak veya dinlemek için kullanılabilir. Başvurulan konumdaki belge mevcut olabilir veya olmayabilir.
Belge Anlık Görüntüsü DocumentSnapshot Firestore veritabanınızdaki bir belgeden okunan verileri içerir. Belirli bir alanı elde etmek için veriler .data() veya .get(<field>) ile çıkarılabilir. Mevcut olmayan bir belgeye işaret eden bir DocumentSnapshot için, herhangi bir veri erişimi 'tanımsız' değerini döndürecektir. Bir belgenin varlığını açıkça doğrulamak için exists() yöntemini kullanabilirsiniz.
AlanYolu FieldPath belgedeki bir alanı ifade eder. Yol, tek bir alan adından (belgedeki en üst düzey alana atıfta bulunarak) veya alan adları listesinden (belgede iç içe geçmiş bir alana atıfta bulunarak) oluşabilir. Alan adlarını sağlayarak bir FieldPath oluşturun. Birden fazla alan adı sağlanırsa yol, belgedeki iç içe geçmiş bir alanı işaret eder.
Alan değeri set() veya update() ile belge alanlarını yazarken kullanılabilecek sentinel değerleri.
Yangın deposu Cloud Firestore hizmet arayüzü. Bu yapıcıyı doğrudan çağırmayın. Bunun yerine getFirestore() işlevini kullanın .
FirestoreError Firestore işlemi tarafından döndürülen bir hata.
GeoPoint Firestore'daki coğrafi konumu temsil eden değişmez bir nesne. Konum enlem/boylam çifti olarak temsil edilir. Enlem değerleri [-90, 90] aralığındadır. Boylam değerleri [-180, 180] aralığındadır.
LoadBundleGörevi Firestore paketini yükleme görevini temsil eder. Paket yükleme ilerlemesinin yanı sıra görev tamamlama ve hata olaylarını da sağlar. API, Promise<LoadBundleTaskProgress> ile uyumludur.
PersistentCacheIndexManager'ı Yerel sorgu yürütme için kullanılan kalıcı önbellek dizinlerini yapılandırmaya yönelik bir PersistentCacheIndexManager . Kullanmak için bir örnek almak üzere getPersistentCacheIndexManager() öğesini çağırın.
Sorgu Query okuyabileceğiniz veya dinleyebileceğiniz bir sorguyu ifade eder. Filtreler ekleyerek ve sıralayarak da iyileştirilmiş Query nesneleri oluşturabilirsiniz.
QueryCompositeFilterConstraint QueryCompositeFilterConstraint , birden fazla QueryFieldFilterConstraint'in mantıksal VEYA veya VE işlemlerini gerçekleştirerek bir Firestore sorgusu tarafından döndürülen belge kümesini daraltmak için kullanılır s veya QueryCompositeFilterConstraint S. QueryCompositeFilterConstraint ler or() veya and() çağrılarak oluşturulur ve daha sonra QueryCompositeFilterConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir.
Sorgu Kısıtlaması Bir Firestore sorgusu tarafından döndürülen belge kümesini daraltmak için QueryConstraint kullanılır. QueryConstraint s, Where() çağrılarak oluşturulur. , tarafından sipariş() , başlamak() , startAfter() , endBefore() , sonunda() , sınır() , limitToLast() ve daha sonra bu QueryConstraint de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir.
SorguBelge Anlık Görüntüsü QueryDocumentSnapshot bir sorgunun parçası olarak Firestore veritabanınızdaki bir belgeden okunan verileri içerir. Belgenin var olduğu garanti edilir ve belirli bir alanı elde etmek için verileri .data() veya .get(<field>) ile çıkarılabilir. QueryDocumentSnapshot , DocumentSnapshot ile aynı API yüzeyini sunar. Sorgu sonuçları yalnızca mevcut belgeleri içerdiğinden, exists özelliği her zaman doğru olacaktır ve data() hiçbir zaman 'tanımsız' değerini döndürmeyecektir.
SorguEndAtConstraint Bir Firestore sorgusu tarafından döndürülen sonuç kümesinin sonundaki belgeleri hariç tutmak için QueryEndAtConstraint kullanılır. QueryEndAtConstraint ler, endAt() veya endBefore() çağrılarak oluşturulur ve daha sonra bu QueryEndAtConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir.
QueryFieldFilterConstraint QueryFieldFilterConstraint , bir veya daha fazla belge alanını filtreleyerek Firestore sorgusu tarafından döndürülen belge kümesini daraltmak için kullanılır. QueryFieldFilterConstraint ler, Where() çağrılarak oluşturulur ve daha sonra bu QueryFieldFilterConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir.
SorguLimitKısıtlaması Bir Firestore sorgusu tarafından döndürülen belge sayısını sınırlamak için QueryLimitConstraint kullanılır. QueryLimitConstraint limit() veya limitToLast() çağrılarak oluşturulur ve daha sonra bu QueryLimitConstraint de içeren yeni bir sorgu örneği oluşturmak için query()' ye iletilebilir.
QueryOrderByConstraint Bir Firestore sorgusu tarafından döndürülen belge kümesini sıralamak için QueryOrderByConstraint kullanılır. QueryOrderByConstraint S, Düzenli () çağırarak oluşturulur ve daha sonra bu QueryOrderByConstraint de içeren yeni bir sorgu örneği oluşturmak için Query () 'e aktarılabilir. Not: Sipariş alanını içermeyen belgeler sorgu sonucunda bulunmayacaktır.
Querysnapshot Bir QuerySnapshot DocumentSnapshot sorgunun sonuçlarını temsil eden sıfır veya daha fazla belge içerir. Belgelere docs özelliği aracılığıyla bir dizi olarak erişilebilir veya forEach yöntemi kullanılarak numaralandırılabilir. Belge sayısı empty ve size özellikleri ile belirlenebilir.
QuerystartatConstraint Bir Firestore sorgusu tarafından döndürülen bir sonuç setinin başlangıcından itibaren belgeleri hariç tutmak için bir QueryStartAtConstraint kullanılır. QueryStartAtConstraint S, Startat () veya StartAfter () çağırarak oluşturulur ve daha sonra bu QueryStartAtConstraint de içeren yeni bir sorgu örneği oluşturmak için Query () 'e aktarılabilir.
Snapshotmetadata Anlık görüntü hakkında, anlık görüntünün durumunu tanımlayan meta veriler.
Zaman damgası Bir Timestamp UTC epoch zamanında nanosaniye çözünürlüğünde saniyeler ve saniyeler ve saniyeler olarak temsil edilen herhangi bir zaman dilimi veya takvimden bağımsız bir noktayı temsil eder. Gregoryen takvimini ilk yıla kadar uzatan Proleptik Gregoryen takvimi kullanılarak kodlanır. Tüm dakikaların 60 saniye uzunluğunda olduğu varsayılarak kodlanmıştır, IE sıçrama saniyeleri "bulaşır", böylece yorum için bir sıçrama ikinci masa gerekmez. Aralık 0001-01-01T00: 00: 00Z ila 9999-12-31T23: 59: 59.999999999Z arasındadır. Örnekler ve diğer özellikler için zaman damgası tanımına bakın .
İşlem Bir işleme referans. Transaction nesnesi, bir işlemin updateFunction aktarılan işlem bağlamında veri okuma ve yazma yöntemlerini sağlar. Bkz. RunTransaction () .
WriteBatch Tek bir atom birimi olarak birden fazla yazma yapmak için kullanılan bir yazma parti. WriteBatch () çağrılarak bir WriteBatch nesnesi edinilebilir. . Yazma toprağına yazma eklemek için yöntemler sağlar. WriteBatch.commit () çağrılıncaya kadar yazmaların hiçbiri işlenemez (veya yerel olarak görünür).

Arayüzler

Arayüz Tanım
Agregatespec Bir dizi toplama ve bunların takma adlarını belirtir.
Belge Bir DocumentChange bir sorguyla eşleşen belgelerde bir değişikliği temsil eder. Etkilenen belgeyi ve meydana gelen değişim türünü içerir.
DocumentData Belge Verileri ( SetDoc () ile kullanım için ) değerlerle eşlenen alanlardan oluşur.
Deney Uzun kirletme kullanıldığında SDK'nın temel ağ aktarımını (WebChannel) yapılandıran seçenekler. Not: Bu arayüz "deneysel" dir ve değişebilir. Bkz FirestoreSettings.experimentalAutoDetectLongPolling , FirestoreSettings.experimentalForceLongPolling ve FirestoreSettings.experimentalLongPollingOptions .
Firoredoredataconverter withConverter() tarafından kullanılan dönüştürücü, AppModelType türünün kullanıcı nesnelerini DbModelType türünün Firestore verilerine dönüştürmek için kullanılır. Dönüştürücü kullanmak, Firestore'dan nesneleri saklarken ve alırken genel tip argümanları belirtmenizi sağlar. Bu bağlamda, "AppModel", ilgili bilgileri ve işlevselliği bir araya getirmek için bir uygulamada kullanılan bir sınıftır. Böyle bir sınıf, örneğin, karmaşık, iç içe veri türlerine sahip özelliklere, hatıra için kullanılan özelliklere, Firestore tarafından desteklenmeyen türlerin özelliklerine ( symbol ve bigint gibi) ve bileşik işlemleri gerçekleştiren yardımcı fonksiyonlara sahip olabilir. Bu tür sınıflar bir Firestore veritabanında saklanması uygun ve/veya mümkün değildir. Bunun yerine, bu tür sınıfların örneklerinin, potansiyel olarak diğer Pojos veya Pojos dizilerinin içine yerleştirilmiş, sadece ilkel özelliklere sahip "düz eski javascript nesneleri" ne (POJOS) dönüştürülmesi gerekir. Bu bağlamda, bu tür "dbmodel" olarak adlandırılır ve Firestore'a devam etmek için uygun bir nesne olacaktır. Kolaylık sağlamak için uygulamalar, FirestoreDataConverter uygulayabilir ve Dönüştürücüyü DocumentReference veya Query gibi Firestore nesneleriyle kaydedebilir ve Firestore'a saklanırken AppModel otomatik olarak DbModel dönüştürmek ve Firestore'dan alınırken DbModel AppModel dönüştürmek için kaydedebilir.
Firestoresettings Bulut Firestore örneğiniz için özel yapılandırmaları belirtir. Diğer yöntemleri çağırmadan önce bunları ayarlamanız gerekir.
Dizin (Beta) Bir Firestore endeksinin SDK tanımı.
İndexconfiguration (Beta) Yerel sorgu yürütmeyi hızlandırmak için Firestore dizinlerinin bir listesi. Dizin tanımının biçiminin açıklaması için JSON formatına bakın.
İndexfield (Beta) Bir dizin yapılandırmasında tek bir alan elemanı.
Loadbundletaskprogress Bir ilerleme güncellemesini veya yükleme demetlerinden elde edilen bir son durumu temsil eder.
Memorycachesettings Bir MemoryLocalCache örneğini yapılandırmak için bir ayar nesnesi.
MemoryAgergarBagecollector Bir çöp toplayıcısı, herhangi bir aktif sorunun bir parçası olmadıklarında belgeleri siler ve bunlara yerel mutasyonlar yoktur. Bu koleksiyoncu, belgelerin çevrimdışı sorgular için önbelleğe alınmaması veya önbelleğe doğrudan sorgular için en düşük bellek ayak izlerini sağlamaya çalışır. Bu koleksiyoncunun bir örneğini oluşturmak için fabrika işlevini kullanın.
MemorylocalCache SDK'ya bellek içi bir önbellek sağlar. Aksi halde açıkça yapılandırılmadıkça bu varsayılan önbellektir. Kullanmak için, fabrika işlevini kullanarak bir örnek oluşturun, ardından örneği FirestoreSettings.cache olarak ayarlayın ve Ayarlar nesnesini kullanarak initializeFirestore çağırın.
MemoryLrugarbagecollector Bir çöp toplayıcısı, en çok kullanılan belgeleri birden çok partiye siler. Bu koleksiyoncu bir hedef boyutu ile yapılandırılır ve yalnızca önbelleğe alınan belgeler hedef boyutunu aştığında koleksiyonu gerçekleştirir. Daha büyük bir bellek ayak izine sahip olma riski altında aynı sorgu veya belge için tekrarlanan arka uçtan sorgulamaktan kaçınır. Bu koleksiyoncunun bir örneğini oluşturmak için fabrika işlevini kullanın.
Kalıcılık Firestore kalıcılığını yapılandırmak için enableIndexedDbPersistence() 'e aktarılabilen ayarlar. Kalıcılık bir Node.js ortamında kullanılamaz.
PersistentCachesettings Bir PersistentLocalCache örneği yapılandırmak için bir Ayar nesnesi. Kalıcı önbellek bir Node.js ortamında kullanılamaz.
PainsistLocalCache SDK'ya indexedDB tarafından desteklenen kalıcı bir önbellek sağlar. Kullanmak için, fabrika işlevini kullanarak bir örnek oluşturun, ardından örneği FirestoreSettings.cache olarak ayarlayın ve Ayarlar nesnesini kullanarak initializeFirestore çağırın.
PainsistMultipletabManager Birden çok sekmeleri destekleyen bir sekme yöneticisi. SDK, SDK'yı kullanarak tüm sekmelerde yapılan sorguları ve mutasyonları senkronize edecektir.
PersistentsingLetabManager Yalnızca bir sekmeyi destekleyen bir sekme yöneticisi, sekmeler arasında senkronizasyon yapılmayacaktır.
PERSISTENTSINGBAnAgersettings Bir PersistentSingleTabManager örneğini yapılandırmak için yazın.
SnapShotListenOptions Sonuç kümesine hangi tür değişiklikleri dahil edeceğini kontrol etmek için onsnapshot () ve querysnapshot.docchanges () 'e aktarılabilen bir seçenek nesnesi.
Snapshotoptions Verilerin bir DocumentSnapshot nasıl alındığını yapılandıran seçenekler (örneğin, henüz nihai değerlerine ayarlanmamış sunucu zaman damgaları için istenen davranış).
İşlemler İşlem davranışını özelleştirme seçenekleri.
Abonelikten çık Çağrıldığında dinleyiciyi kaldıran onSnapshot() tarafından döndürülen bir işlev.

Değişkenler

Değişken Tanım
Cache_size_unlimited LRU çöp koleksiyonunun devre dışı bırakılması için sabit olarak kullanılan sabit. Bu değeri, Firestore örneğine aktarılan ayarlardaki cacheSizeBytes olarak ayarlayın.

Tip takma adlar

Tip takma ad Tanım
Addprefixtokeys Her anahtarın bir noktaya eklenen dış anahtarla önek olduğu yeni bir harita döndürür.
AgregateFieldType Firestore tarafından desteklenen tüm AggregateField türlerinin birleşmesi.
Agregatespecdata Anahtarları bir AggregateSpec alınan ve değerleri, giriş AggregateSpec karşılık gelen AggregateField tarafından gerçekleştirilen agregasyonun sonucu olan bir tip.
AgregateType Gerçekleştirilecek toplam türü temsil eden sendika tipi.
Childupdatefields Belirli bir T1 tipi için iç içe geçmiş alanları hesaplamak için yardımcı. Bu, undefined | {...} (isteğe bağlı sahne için olur) veya {a: A} | {b: B} . Bu kullanım durumunda V , T[K] birliğin Record dağıtmak için kullanılır, çünkü T[K] bir ifade olarak değerlendirilir ve dağıtılmaz. Bkz.
DocumentChangetype Bir DocumentChange türü 'eklenebilir', 'kaldırıldı' veya 'değiştirilmiş' olabilir.
Firestoreerrorcode Firestore durum kodları kümesi. Kodlar GRPC tarafından maruz kalanlarda aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Olası değerler: - 'iptal edildi': işlem iptal edildi (tipik olarak arayan tarafından). - 'Bilinmeyen': Bilinmeyen hata veya farklı bir hata alanından bir hata. - 'Geçersiz-Argument': Müşteri geçersiz bir argüman belirtti. Bunun 'Başarısızlıktan' farklı olduğunu unutmayın. 'Geçersiz argüman', sistemin durumundan bağımsız olarak sorunlu olan argümanları gösterir (örneğin geçersiz bir alan adı). - 'Son tarih aşıldı': İşlem tamamlanmadan önce son teslim tarihi süresi dolmadan. Sistemin durumunu değiştiren işlemler için, işlem başarıyla tamamlanmış olsa bile bu hata döndürülebilir. Örneğin, bir sunucudan başarılı bir yanıt, son başvuru tarihinin süresi dolabın yeterince gecikmiş olabilir. - 'Bulunmayan': İstenen bazı belgeler bulunamadı. - 'Zaten var': Oluşturmaya çalıştığımız bazı belgeler zaten var. - 'İzinten Denetimli': Arayanın belirtilen işlemi yürütme izni yoktur. -'Kaynak tarafından tükenmiş': Bazı kaynaklar tükenmiştir, belki de kullanıcı başına bir kota veya belki de tüm dosya sistemi alanın dışındadır. - 'Başarısızlık-Koşul': Sistem, işlemin yürütülmesi için gerekli bir durumda olmadığı için işlem reddedildi. - 'Durdurulmuş': Tipik olarak işlem iptalleri vb. Gibi eşzamanlılık sorunu nedeniyle işlemi iptal edildi.- 'Aralık dışı': Operasyon geçerli aralığın ötesine geçti. - 'Uygulanmamış': İşlem uygulanmaz veya desteklenmez/etkinleştirilmez. - 'Dahili': Dahili hatalar. Altta yatan sistem tarafından beklenen bazı değişmezlerin kırıldığı anlamına gelir. Bu hatalardan birini görürseniz, bir şey çok kırılır. - 'Kullanılamaz': Hizmet şu anda kullanılamıyor. Bu büyük olasılıkla geçici bir durumdur ve bir geri çekilme ile yeniden denenerek düzeltilebilir. - 'Veri kaybı': Tahmin edilemez veri kaybı veya yolsuzluk. - 'Kemerin Eklenmemiş': Talep, işlem için geçerli kimlik doğrulama kimlik bilgileri yoktur.
Firestorelocalcache Desteklenen tüm SDK önbellek katmanından sendika türü.
Dinlemek Bir sorgunun dinlediği kaynağı açıklayın. Hem önbellek hem de sunucu değişikliklerini dinlemek için default olarak ayarlayın. Yalnızca önbellek değişikliklerini dinlemek için cache olarak ayarlayın.
MemorygarbaGecolector Hafıza yerel önbelleği için tüm destek gabage koleksiyoncularından sendika türü.
Nestedupdatefields Her alan için (örn. 'Bar'), tüm iç içe anahtarları bulun (örn. { 'Bar.baz': t1, 'bar.qux': t2 } ). Hepsi isteğe bağlı olarak işaretlenmiş tüm olası anahtarları içeren tek bir harita yapmak için bunları birbirine takın
Sipariş Bir sipariş () maddesinin yönü 'desc' veya 'ASC' (azalan veya yükselen) olarak belirtilir.
Kısmiwithfieldvalue TypeScript'in Partial<T> e benzer, ancak iç içe geçmiş alanların atlanmasına ve alan değerlerinin mülk değerleri olarak aktarılmasına izin verir.
Persistenttabmanager Mevcut tüm sekme yöneticilerinin birliği.
İlkel İlkel türler.
QueryconstraintType Bu SDK'da mevcut olan farklı sorgu kısıtlamalarını açıklar.
QueryFilterConstraint QueryFilterConstraint , QueryFieldFilterConstraint ve QueryCompositeFilterConstraint'i temsil eden bir yardımcı sendika türüdür .
Querynonfilterconstraint QueryNonFilterConstraint belge kümesini daraltmak veya sipariş etmek için kullanılan, ancak bir belge alanında açıkça filtrelemeyen sorgulamaları temsil eden bir yardımcı birlik türüdür. QueryNonFilterConstraint S, Düzenli () çağırarak oluşturulur () , başlamak() , startafter () , endBefore () , sonunda() , Limit () veya Limittolast () ve daha sonra QueryConstraint de içeren yeni bir sorgu örneği oluşturmak için query () 'e aktarılabilir.
Setoptions SetDoc () davranışını yapılandıran bir seçenek nesnesi ve çağrılar. Bu çağrılar, bir SetOptions ile merge: true ile hedef belgelerin üzerine yazmak yerine ayrıntılı birleştirme gerçekleştirecek şekilde yapılandırılabilir.
Görevli Paket yükleme görevlerinin durumunu temsil eder. Hem 'hata' hem de 'başarı' batırılıyor: Görev iptal edilecek veya tamamlayacak ve rapor edildikten sonra daha fazla güncelleme olmayacak.
UnionTointersection Birlik tipi U = T1 | T2 | ... , kesişen bir tip döndürür (T1 & T2 & ...) . Koşullu tiplerden dağıtım koşullu türleri ve çıkarım kullanır. Bu çalışır, çünkü aynı tip değişken için birden fazla aday, varyant pozisyonlarında bir kavşak türünün çıkarılmasına neden olur. https://www.typescriptlang.org/docs/handbook/adved-types.html#type-interence-in-inditional-types https: https: -tip
Veriyi güncelle Verileri Güncelle ( UpdateC () ile kullanım için ) değerlerle eşlenen alan yollarından (örneğin 'foo' veya 'foo.baz') oluşur. Nokta içeren alanlar belgede iç içe geçmiş alanlara başvurur. Field Değerleri mülk değerleri olarak aktarılabilir.
Where Filterop Bir WHERE () maddesindeki filtre koşulları '& lt;', '==', '! =', '& Gt; =', '& gt;', 'dizi-contains' dizeleri kullanılarak belirtilir. , 'in', 'dizi-contains-herhangi bir' ve 'no-in'.
WithfieldValue Tür güvenliğini korurken alan değerlerinin bir özellik değeri olarak aktarılmasına izin verir.

işlev (uygulama, ...)

GetFirestore (App)

Sağlanan Firebaseapp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.

İmza:

export declare function getFirestore(app: FirebaseApp): Firestore;

Parametreler

Parametre Tip Tanım
uygulama Firebaseapp Döndürülen Firestore örneğinin ilişkili olduğu Firebaseapp örneği.

İadeler:

Yangın deposu

Sağlanan uygulamanın varsayılan firestore örneği.

GetFirestore (App, DatabaseId)

Bu API, geliştiriciler için bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.

Sağlanan Firebaseapp ile ilişkili mevcut adlandırılmış Firestore örneğini döndürür . Örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.

İmza:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

Parametreler

Parametre Tip Tanım
uygulama Firebaseapp Döndürülen Firestore örneğinin ilişkili olduğu Firebaseapp örneği.
veritabaseid sicim Veritabanının adı.

İadeler:

Yangın deposu

Sağlanan uygulamanın adlandırılmış Firestore örneği.

InitializeFirestore (App, Ayarlar, DatabaseId)

Sağlanan ayarlarla yeni bir Firestore örneğini başlatır. Yalnızca getFirestore () dahil olmak üzere başka bir işlevden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore () çağrısına eşdeğerdir .

İmza:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

Parametreler

Parametre Tip Tanım
uygulama Firebaseapp Firestore örneğinin ilişkilendirileceği Firebaseapp .
ayarlar Firestoresettings Bir Ayarlar Nesnesi Firestore örneğini yapılandırmak için.
veritabaseid sicim Veritabanının adı.

İadeler:

Yangın deposu

Yeni başlatılan bir Firestore örneği.

işlev (firestore, ...)

ClearIndexedDbpersistence (Firestore)

Kalıcı depolamayı temizler. Bu, beklemede yazma ve önbelleğe alınmış belgeleri içerir.

Firestore örneği başlatılmadığında (uygulama sonlandırıldıktan sonra veya uygulama ilk başlatıldığında) çağrılmalıdır. Başlangıçta, bu işlev diğer işlevlerden önce çağrılmalıdır ( InitializeFirestore () veya GetFirestore () dışında )). Firestore örneği hala çalışıyorsa, vaat failed-precondition hata kodu ile reddedilecektir. .

İmza:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Firestore örneği için kalıcılığı temizlemek.

İadeler:

Söz <void>

Kalıcı depolama temizlendiğinde çözülen bir Promise . Aksi takdirde, vaat bir hata ile reddedilir.

Koleksiyon (Firestore, Path, Pathsegments)

Belirtilen mutlak yolda koleksiyona atıfta bulunan bir CollectionReference örneği alır.

İmza:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Kök Firestore örneğine bir referans.
yol sicim Bir koleksiyona doğru ayrılmış bir yol.
yol sicim[] İlk argümana göre uygulanacak ek yol segmentleri.

İadeler:

Toplama < DocumentData , DocumentData >

CollectionReference örneği.

İstisnalar

Son yolun eşit sayıda segmenti varsa ve bir koleksiyona işaret etmiyorsa.

CollectionGroup (Firestore, CollectionId)

Veritabanında, verilen collectionId bir koleksiyonda veya alt toplama işleminde bulunan tüm belgeleri içeren yeni bir Query örneği oluşturur ve döndürür .

İmza:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Kök Firestore örneğine bir referans.
koleksiyon sicim Sorgulanacak koleksiyonları tanımlar. Yolunun son segmenti olarak bu kimlikle her koleksiyon veya alt toplama dahil edilecektir. Eğik çizgi içeremez.

İadeler:

Sorgu < DocumentData , DocumentData >

Oluşturulan Query .

ConnectFirestoreEmulator (firestore, ana bilgisayar, bağlantı noktası, seçenekler)

Bulut Firestore Emulator ile iletişim kurmak için bu örneği değiştirin.

İmza:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Emülatöre bağlanmak için yapılandırılacak Firestore örneği.
ev sahibi sicim Emülatör ana bilgisayar (Örn: Localhost).
liman sayı Emülatör portu (Örn: 9000).
seçenekler {Mockusertoken?: EmulatormockTokenOptions | sicim; }

İadeler:

geçersiz

DisablenetWork (Firestore)

Bu örnek için ağ kullanımını devre dışı bırakır. Enablenetwork () aracılığıyla yeniden etkinleştirilebilir . Ağ devre dışı bırakılırken, herhangi bir anlık görüntü dinleyicisi, getDoc() veya getDocs() çağrıları önbellekten sonuçları döndürür ve ağ geri yüklenene kadar herhangi bir yazma işlemi sıraya alınır.

İmza:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu

İadeler:

Söz <void>

Ağ devre dışı bırakıldıktan sonra çözülen bir Promise .

Doc (Firestore, Path, Pathsegments)

Belgeyi belirtilen mutlak yolda ifade eden bir DocumentReference örneği alır.

İmza:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Kök Firestore örneğine bir referans.
yol sicim Bir belgeye eğik çizgi ile ayrılmış bir yol.
yol sicim[] İlk argümana göre uygulanacak ek yol segmentleri.

İadeler:

Belge < DocumentData , DocumentData >

DocumentReference örneği.

İstisnalar

Son yolun tek sayıda segmenti varsa ve bir belgeye işaret etmiyorsa.

ENABLEDEXEDDBPERSISTENCE (Firestore, PersistenceSettings)

Bu işlev gelecekteki büyük bir sürümde kaldırılacaktır. Bunun yerine, indexedDB önbelleğini açmak için FirestoreSettings.localCache bir PersistentLocalCache örneğine ayarlayın. FirestoreSettings.localCache zaten belirtildiğinde bu işlevi çağırmak bir istisna atacaktır.

Mümkünse kalıcı depolama sağlama girişimleri.

Başarısızlıktan sonra, enableIndexedDbPersistence() sözü reddedecektir veya bir istisna atacaktır. Bunun başarısız olmasının birkaç nedeni vardır, bu da hata üzerindeki code tanımlanabilir.

* Başarısızlık: Uygulama zaten başka bir tarayıcı sekmesinde açıktır. * Uygulanmamış: Tarayıcı, çevrimdışı kalıcılık uygulamasıyla uyumsuzdur.

Bir arızadan sonra bile, Firestore örneğinin kullanılabilir kalacağını, ancak çevrimdışı kalıcılığın devre dışı bırakılacağını unutmayın.

Kalıcılık bir Node.js ortamında kullanılamaz.

İmza:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Kalıcılığını etkinleştirmek için firestore örneği.
kalıcılık Kalıcılık İsteğe bağlı ayarlar, kalıcılığı yapılandırmak için nesne.

İadeler:

Söz <void>

Kalıcı depolamayı başarıyla temsil eden bir Promise .

EnableMultitAbindexedDbpersistence (Firestore)

Bu işlev gelecekteki büyük bir sürümde kaldırılacaktır. Bunun yerine, indexedDB önbelleğini açmak için FirestoreSettings.localCache bir PersistentLocalCache örneğine ayarlayın. FirestoreSettings.localCache zaten belirtildiğinde bu işlevi çağırmak bir istisna atacaktır.

Mümkünse çoklu örgü kalıcı depolamayı etkinleştirme girişimleri. Tüm sekmelerde etkinleştirilirse, tüm işlemler, bağlı tüm örneklerde sorguların paylaşılan yürütülmesi ve gecikme telafi edilmiş yerel belge güncellemeleri de dahil olmak üzere yerel kalıcılığa erişimi paylaşır.

Başarısızlıktan sonra, enableMultiTabIndexedDbPersistence() sözü reddeder veya bir istisna atar. Bunun başarısız olmasının birkaç nedeni vardır, bu da hata üzerindeki code tanımlanabilir.

* Başarısızlık: Uygulama zaten başka bir tarayıcı sekmesinde açıktır ve çoklu sabah etkinleştirilmez. * Uygulanmamış: Tarayıcı, çevrimdışı kalıcılık uygulamasıyla uyumsuzdur.

Bir arızadan sonra bile, Firestore örneğinin kullanılabilir kalacağını, ancak çevrimdışı kalıcılığın devre dışı bırakılacağını unutmayın.

İmza:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Kalıcılığını etkinleştirmek için firestore örneği.

İadeler:

Söz <void>

Kalıcı depolamayı başarıyla temsil eden bir Promise .

enablenetwork (firestore)

Disablenetwork () ' i önceden bir çağrıdan sonra bu firestore örneği için ağın kullanımı .

İmza:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu

İadeler:

Söz <void>

Ağ etkinleştirildikten sonra çözülen bir Promise .

GetpersistentCacheIndexManager (Firestore)

Verilen Firestore nesnesi tarafından kullanılan PersistentCache endeks yöneticisini döndürür.

PersistentCacheIndexManager örneği veya yerel kalıcı depolama kullanılmıyorsa null .

İmza:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu

İadeler:

PersistentCacheIndexManager | hükümsüz

LoadBundle (Firestore, Bundledata)

Yerel önbelleğe bir firestore demeti yükler.

İmza:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Firestore örneği için paketler yüklemek.
Bundledata ReadableReam <Uint8Array> | ArrayBuffer | sicim Yüklenecek demeti temsil eden bir nesne. Geçerli nesneler ArrayBuffer , ReadableStream<Uint8Array> veya string .

İadeler:

Loadbundletask

Arayanları ilerleme güncellemeleri ve tamamlama veya hata olayları ile bildiren bir LoadBundleTask nesnesi. Bir Promise<LoadBundleTaskProgress> olarak kullanılabilir. .

NameQuery (Firestore, Ad)

Verilen adla tanımlanan yerel önbellekten bir Firestore sorgusu okur.

Adlandırılmış sorgular, sunucu tarafında (ortaya çıkan belgelerle birlikte) paketler halinde paketlenir ve loadBundle kullanılarak yerel önbelleğe yüklenir . Yerel önbelleğe girdikten sonra, bir sorguyu adıyla çıkarmak için bu yöntemi kullanın.

İmza:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Sorguyu okumak için firestore örneği.
isim sicim Sorgunun adı.

İadeler:

Söz < Sorgu | null>

Sorgu veya null ile çözülen bir Promise .

Onsnapshotsinsync (Firestore, Gözlemci)

Senkro bir etkinlik için bir dinleyici ekler. Senkal-sync olayları, tek bir sunucu tarafından oluşturulan değişiklik birden fazla dinleyiciyi etkilese bile, belirli bir değişiklikten etkilenen tüm dinleyicilerin ateş ettiğini gösterir.

Not: Senkronizasyondaki anlık görüntüler, dinleyicilerin yalnızca birbirleriyle senkronize olduğunu gösterir, ancak bu anlık görüntülerin sunucu ile senkronize olup olmadığı ile ilgili değildir. Önbellekten mi yoksa sunucudan bir anlık görüntü olup olmadığını belirlemek için tek tek dinleyicilerde SnapShotMetadata kullanın.

İmza:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Anlık görüntüleri senkronize etmek için Firestore örneği.
gözlemci {sonraki?: (değer: void) => void; Hata?: (Hata: FirestoreError ) => void; Complete?: () => void; } next ve error geri arama içeren tek bir nesne.

İadeler:

Abonelikten çık

Anlık görüntü dinleyicisini iptal etmek için çağrılabilecek abonelikten çıkma işlevi.

Onsnapshotsinsync (Firestore, Onsync)

Senkro bir etkinlik için bir dinleyici ekler. Senkal-sync olayları, tek bir sunucu tarafından oluşturulan değişiklik birden fazla dinleyiciyi etkilese bile, belirli bir değişiklikten etkilenen tüm dinleyicilerin ateş ettiğini gösterir.

Not: Senkronizasyondaki anlık görüntüler, dinleyicilerin yalnızca birbirleriyle senkronize olduğunu gösterir, ancak bu anlık görüntülerin sunucu ile senkronize olup olmadığı ile ilgili değildir. Önbellekten mi yoksa sunucudan bir anlık görüntü olup olmadığını belirlemek için tek tek dinleyicilerde SnapshotMetadata kullanın.

İmza:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Anlık görüntüleri senkronize etmek için Firestore örneği.
onsync () => geçersiz Tüm anlık görüntü dinleyicileri birbirleriyle her senkronize olduğunda çağrılacak bir geri arama.

İadeler:

Abonelikten çık

Anlık görüntü dinleyicisini iptal etmek için çağrılabilecek abonelikten çıkma işlevi.

RunTransaction (Firestore, UpdateFonction, Seçenekler)

Verilen updateFunction yürütür ve ardından işlem içinde uygulanan değişiklikleri işlemeye çalışır. İşlemde okunan herhangi bir belge değiştiyse, Cloud Firestore updateFunction . 5 denemeden sonra taahhütte bulunmazsa, işlem başarısız olur.

Tek bir işlemde izin verilen maksimum yazma sayısı 500'dür.

İmza:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Bu işlemi yürütmek için Firestore veritabanına bir referans.
Güncelleme Fonksiyonu (İşlem: İşlem ) => Vaat <t> İşlem bağlamında yürütülecek işlev.
seçenekler İşlemler Bir seçenek nesnesi, maksimum taahhüt denemesi sayısını yapılandırmak için.

İadeler:

Söz <T>

İşlem başarıyla tamamlandı veya açıkça iptal edildi ( updateFunction başarısız bir söz döndürdü), updateFunction tarafından döndürülen söz buraya iade edildi. Aksi takdirde, işlem başarısız olursa, ilgili hata hatası ile reddedilen bir vaat döndürülür.

SetIndexConfiguration (Firestore, Yapılandırma)

Bu API, geliştiriciler için bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.

Önbellek dizinleri manuel olarak oluşturmak yerine, SDK'nın yerel olarak çalışan sorgular için önbellek dizinlerinin oluşturulup oluşturulmayacağına karar vermesine izin vermek için enablePersistentCacheIndexAutoCreation() kullanmayı düşünün.

Yerel sorgu yürütme için dizinleme yapılandırır. Önceki herhangi bir dizin yapılandırması geçersiz kılınır. Endeks yapılandırması devam ettikten sonra Promise çözülür.

Dizin girişlerinin kendileri eşzamansız olarak yaratılır. Endeksler henüz mevcut olmasa bile endeksleme gerektiren sorguları kullanmaya devam edebilirsiniz. Sorgu yürütme, dizin girişleri yazıldıktan sonra dizin kullanmaya otomatik olarak başlar.

Dizinler yalnızca indexedDB kalıcılığı ile desteklenir. IndexedDB etkin değilse, herhangi bir dizin yapılandırması yok sayılır.

İmza:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Dizinleri yapılandırmak için firestore örneği.
yapılandırma İndexconfiguration Dizin tanımı.

İadeler:

Söz <void>

Tüm endeksler başarıyla yapılandırıldıktan sonra çözülen bir Promise .

İstisnalar

FirestoreError JSON biçimi geçersizse.

SetIndexConfiguration (Firestore, JSON)

Bu API, geliştiriciler için bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.

Önbellek dizinleri manuel olarak oluşturmak yerine, SDK'nın yerel olarak çalışan sorgular için önbellek dizinlerinin oluşturulup oluşturulmayacağına karar vermesine izin vermek için enablePersistentCacheIndexAutoCreation() kullanmayı düşünün.

Yerel sorgu yürütme için dizinleme yapılandırır. Önceki herhangi bir dizin yapılandırması geçersiz kılınır. Endeks yapılandırması devam ettikten sonra Promise çözülür.

Dizin girişlerinin kendileri eşzamansız olarak yaratılır. Endeksler henüz mevcut olmasa bile endeksleme gerektiren sorguları kullanmaya devam edebilirsiniz. Sorgu yürütme, dizin girişleri yazıldıktan sonra dizin kullanmaya otomatik olarak başlar.

Dizinler yalnızca indexedDB kalıcılığı ile desteklenir. Bir dizin yapılandırması ayarlamadan önce enableIndexedDbPersistence() veya enableMultiTabIndexedDbPersistence() i çağırın. IndexedDB etkin değilse, herhangi bir dizin yapılandırması yok sayılır.

Yöntem, Firebase CLI ( firebase firestore:indexes tarafından dışa aktarılan JSON formatını kabul eder ). JSON biçimi geçersizse, bu yöntem bir hata atar.

İmza:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu Dizinleri yapılandırmak için firestore örneği.
json sicim Firebase CLI tarafından dışa aktarılan JSON formatı.

İadeler:

Söz <void>

Tüm endeksler başarıyla yapılandırıldıktan sonra çözülen bir Promise .

İstisnalar

FirestoreError JSON biçimi geçersizse.

sonlandır (firestore)

Verilen Firestore örneğini sonlandırır.

terminate() çağrıldıktan sonra yalnızca clearIndexedDbPersistence() işlevi kullanılabilir. Başka herhangi bir işlev FirestoreError atacaktır .

Fesihten sonra yeniden başlatmak için, GetFirestore () ile yeni bir FirebaseFirestore örneği oluşturun () .

Fesih bekleyen yazıları iptal etmez ve sunucudan yanıt bekleyen vaatler çözülmez. Kalıcılık etkinleştirdiyseniz, bu örneğe bir sonraki başlattığınızda, bu yazıları sunucuya göndermeye devam edecektir.

İmza:

export declare function terminate(firestore: Firestore): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu

İadeler:

Söz <void>

Örnek başarıyla feshedildiğinde çözülen bir Promise .

WaitForpendingWrites (Firestore)

Aktif kullanıcı için şu anda bekleyen tüm yazarlar arka uç tarafından kabul edilene kadar bekler.

Geri dönen söz, olağanüstü yazma söz konusu değilse hemen çözülür. Aksi takdirde, vaat daha önce verilen tüm yazıları bekler (önceki bir uygulama oturumunda yazılanlar dahil), ancak işlev çağrıldıktan sonra eklenen yazıları beklemez. Ek yazılar beklemek istiyorsanız, tekrar waitForPendingWrites() arayın.

Kullanıcı değişiklikleri sırasında olağanüstü waitForPendingWrites() vaatleri reddedilir.

İmza:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu

İadeler:

Söz <void>

Şu anda beklemede olan tüm yazmaların arka uç tarafından kabul edildiğinde çözülen bir Promise .

WriteBatch (Firestore)

Tek bir atom işlemi olarak birden fazla yazma yapmak için kullanılan bir yazma parti oluşturur. Tek bir yazma tabanında izin verilen maksimum yazma sayısı 500'dür.

İşlemlerin aksine, yazma partileri çevrimdışı olarak devam eder ve bu nedenle yazmalarınızı okuma verilerinde koşullandırmanız gerekmediğinde tercih edilir.

İmza:

export declare function writeBatch(firestore: Firestore): WriteBatch;

Parametreler

Parametre Tip Tanım
firestör Yangın deposu

İadeler:

WriteBatch

Birden fazla yazmayı atomik olarak yürütmek için kullanılabilecek bir Write -Batch .

işlev()

saymak()

Bir sorgunun sonuç kümesindeki belgelerin sayısını hesaplamak için kullanılabilecek bir AgregateField nesnesi oluşturun.

İmza:

export declare function count(): AggregateField<number>;

İadeler:

Toplu <sayı>

DeleteField ()

Bir alanı silmek için işaretlemek için {merge: true} ile UpdateC () veya setDoc () ile kullanım için bir sentinel döndürür.

İmza:

export declare function deleteField(): FieldValue;

İadeler:

Alan değeri

DocumentId ()

Bir belgenin kimliğine atıfta bulunmak için özel bir Sentinel FieldPath döndürür. Sorgularda belge kimliğine göre sıralamak veya filtrelemek için kullanılabilir.

İmza:

export declare function documentId(): FieldPath;

İadeler:

Saha yağı

getFirestore ()

Varsayılan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.

İmza:

export declare function getFirestore(): Firestore;

İadeler:

Yangın deposu

Varsayılan uygulamanın varsayılan firestore örneği.

MemoryAgergarBagecollector ()

MemoryEagerGarbageCollector bir örneğini oluşturur . Bu, aksi halde açıkça belirtilmedikçe varsayılan çöp toplayıcıdır.

İmza:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

İadeler:

MemoryAgergarBagecollector

persistentmultipletabmanager ()

PersistentMultipleTabManager örneği oluşturur .

İmza:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

İadeler:

PainsistMultipletabManager

ServerTIMESTAMP ()

Yazılı verilere sunucu tarafından oluşturulan bir zaman damgası eklemek için setDoc () veya updatedoc () ile kullanılan bir sentinel döndürür.

İmza:

export declare function serverTimestamp(): FieldValue;

İadeler:

Alan değeri

işlev (databaseId, ...)

GetFirestore (DatabaseId)

Bu API, geliştiriciler için bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.

Varsayılan FirebaseApp ile ilişkili mevcut adlandırılmış Firestore örneğini döndürür . Örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.

İmza:

export declare function getFirestore(databaseId: string): Firestore;

Parametreler

Parametre Tip Tanım
veritabaseid sicim Veritabanının adı.

İadeler:

Yangın deposu

Varsayılan uygulamanın adlandırılmış Firestore örneği.

işlev (öğeler, ...)

Arrayremove (Elements)

SetDoc () ile kullanılabilecek özel bir değer döndürür veya sunucuya verilen öğeleri sunucuda zaten var olan herhangi bir dizi değerinden kaldırmasını söyler. Belirtilen her öğenin tüm örnekleri diziden kaldırılır. Değiştirilen alan zaten bir dizi değilse, boş bir dizi ile üzerine yazılır.

İmza:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

Parametreler

Parametre Tip Tanım
elementler Bilinmeyen[] The elements to remove from the array.

İadeler:

Alan değeri

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

arrayUnion(elements)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.

İmza:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

Parametreler

Parametre Tip Tanım
elementler Bilinmeyen[] The elements to union into the array.

İadeler:

Alan değeri

The FieldValue sentinel for use in a call to setDoc() or updateDoc() .

function(field, ...)

average(field)

Create an AggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

İmza:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

Parametreler

Parametre Tip Tanım
alan string | FieldPath Specifies the field to average across the result set.

İadeler:

AggregateField <number | null>

sum(field)

Create an AggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

İmza:

export declare function sum(field: string | FieldPath): AggregateField<number>;

Parametreler

Parametre Tip Tanım
alan string | FieldPath Specifies the field to sum across the result set.

İadeler:

AggregateField <sayı>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Creates a QueryOrderByConstraint that sorts the query result by the specified field, optionally in descending order instead of ascending.

İmza:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

Parametreler

Parametre Tip Tanım
fieldPath string | FieldPath The field to sort by.
directionStr OrderByDirection Optional direction to sort by ('asc' or 'desc'). If not specified, order will be ascending.

İadeler:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

İmza:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

Parametreler

Parametre Tip Tanım
fieldPath string | FieldPath The path to compare
opStr WhereFilterOp The operation string (eg "&lt;", "&lt;=", "==", "&lt;", "&lt;=", "!=").
değer Bilinmeyen The value for comparison

İadeler:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

İmza:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

Parametreler

Parametre Tip Tanım
fieldValues Bilinmeyen[] The field values to end this query at, in order of the query's order by.

İadeler:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

İmza:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

Parametreler

Parametre Tip Tanım
fieldValues Bilinmeyen[] The field values to end this query before, in order of the query's order by.

İadeler:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

İmza:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

Parametreler

Parametre Tip Tanım
fieldValues Bilinmeyen[] The field values to start this query after, in order of the query's order by.

İadeler:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

İmza:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

Parametreler

Parametre Tip Tanım
fieldValues Bilinmeyen[] The field values to start this query at, in order of the query's order by.

İadeler:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

İmza:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

Parametreler

Parametre Tip Tanım
indexManager PersistentCacheIndexManager

İadeler:

geçersiz

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

İmza:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Parametreler

Parametre Tip Tanım
indexManager PersistentCacheIndexManager

İadeler:

geçersiz

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

Bu özellik varsayılan olarak devredışı bırakılmıştır.

İmza:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Parametreler

Parametre Tip Tanım
indexManager PersistentCacheIndexManager

İadeler:

geçersiz

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

İmza:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

Parametreler

Parametre Tip Tanım
sol AggregateField <unknown> Compare this AggregateField to the right .
Sağ AggregateField <unknown> Compare this AggregateField to the left .

İadeler:

boolean

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

İmza:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

Parametreler

Parametre Tip Tanım
sol AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The first AggregateQuerySnapshot to compare.
Sağ AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The second AggregateQuerySnapshot to compare.

İadeler:

boolean

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

İmza:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

Parametreler

Parametre Tip Tanım
sol Sorgu <AppModelType, DbModelType> A Query to compare.
Sağ Sorgu <AppModelType, DbModelType> A Query to compare.

İadeler:

boolean

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

İmza:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

Parametreler

Parametre Tip Tanım
sol DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType> A reference to compare.
Sağ DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType> A reference to compare.

İadeler:

boolean

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

İmza:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

Parametreler

Parametre Tip Tanım
sol DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType> A snapshot to compare.
Sağ DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType> A snapshot to compare.

İadeler:

boolean

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

İmza:

export declare function limit(limit: number): QueryLimitConstraint;

Parametreler

Parametre Tip Tanım
sınır sayı The maximum number of items to return.

İadeler:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

İmza:

export declare function limitToLast(limit: number): QueryLimitConstraint;

Parametreler

Parametre Tip Tanım
sınır sayı The maximum number of items to return.

İadeler:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

İmza:

export declare function setLogLevel(logLevel: LogLevel): void;

Parametreler

Parametre Tip Tanım
logLevel LogLevel The verbosity you set for activity and error logging. Can be any of the following values:
  • debug for the most verbose logging level, primarily for debugging.
  • error to log errors only.
  • silent to turn off logging.

İadeler:

geçersiz

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

İmza:

export declare function increment(n: number): FieldValue;

Parametreler

Parametre Tip Tanım
N sayı The value to increment by.

İadeler:

Alan değeri

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

İmza:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The query whose result set is aggregated over.
aggregateSpec AggregateSpecType An AggregateSpec object that specifies the aggregates to perform over the result set. The AggregateSpec specifies aliases for each aggregate, which can be used to retrieve the aggregate result.

İadeler:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Örnek

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

İmza:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The query whose result set size is calculated.

İadeler:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

İmza:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType>

İadeler:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

İmza:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType>

İadeler:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

İmza:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType>

İadeler:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The query to listen to.
gözlemci { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The query to listen to.
seçenekler SnapshotListenOptions Options controlling the listen behavior.
gözlemci { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The query to listen to.
sonraki (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The query to listen to.
seçenekler SnapshotListenOptions Options controlling the listen behavior.
sonraki (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

İmza:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
compositeFilter QueryCompositeFilterConstraint The QueryCompositeFilterConstraint to apply. Create QueryCompositeFilterConstraint using and() or or() .
queryConstraints QueryNonFilterConstraint [] Additional QueryNonFilterConstraint s to apply (eg orderBy() , limit() ).

İadeler:

Sorgu <AppModelType, DbModelType>

İstisnalar

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

İmza:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

Parametreler

Parametre Tip Tanım
sorgu Sorgu <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
queryConstraints QueryConstraint [] The list of QueryConstraint s to apply.

İadeler:

Sorgu <AppModelType, DbModelType>

İstisnalar

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

İmza:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parametreler

Parametre Tip Tanım
queryConstraints QueryFilterConstraint [] İsteğe bağlı. The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , veya() , or and() .

İadeler:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

İmza:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parametreler

Parametre Tip Tanım
queryConstraints QueryFilterConstraint [] İsteğe bağlı. The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , veya() , or and() .

İadeler:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

İmza:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
referans CollectionReference <AppModelType, DbModelType> A reference to the collection to add this document to.
veri WithFieldValue <AppModelType> An Object containing the data for the new document.

İadeler:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

İmza:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametreler

Parametre Tip Tanım
referans CollectionReference <AppModelType, DbModelType> A reference to a collection.
yol sicim A slash-separated path to a collection.
pathSegments sicim[] Additional path segments to apply relative to the first argument.

İadeler:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

İstisnalar

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

İmza:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to a Firestore document.
yol sicim A slash-separated path to a collection.
pathSegments sicim[] Additional path segments that will be applied relative to the first argument.

İadeler:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

İstisnalar

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

İmza:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to delete.

İadeler:

Promise<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

İmza:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

Parametreler

Parametre Tip Tanım
referans CollectionReference <AppModelType, DbModelType> A reference to a collection.
yol sicim A slash-separated path to a document. Has to be omitted to use auto-genrated IDs.
pathSegments sicim[] Additional path segments that will be applied relative to the first argument.

İadeler:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

İstisnalar

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

İmza:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to a Firestore document.
yol sicim A slash-separated path to a document.
pathSegments sicim[] Additional path segments that will be applied relative to the first argument.

İadeler:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

İstisnalar

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

İmza:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> The reference of the document to fetch.

İadeler:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

İmza:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType>

İadeler:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

İmza:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType>

İadeler:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
gözlemci { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
seçenekler SnapshotListenOptions Options controlling the listen behavior.
gözlemci { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
sonraki (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

İmza:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
seçenekler SnapshotListenOptions Options controlling the listen behavior.
sonraki (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

İadeler:

Abonelikten çık

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

İmza:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to write.
veri WithFieldValue <AppModelType> A map of the fields and values for the document.

İadeler:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

İmza:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to write.
veri PartialWithFieldValue <AppModelType> A map of the fields and values for the document.
seçenekler SetOptions An object to configure the set behavior.

İadeler:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

İmza:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to update.
veri Veriyi güncelle <DbModelType> An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

İadeler:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

İmza:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Parametreler

Parametre Tip Tanım
referans DocumentReference <AppModelType, DbModelType> A reference to the document to update.
alan string | FieldPath The first field to update.
değer Bilinmeyen The first value.
moreFieldsAndValues Bilinmeyen[] Additional key value pairs.

İadeler:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

İmza:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

Parametreler

Parametre Tip Tanım
ayarlar MemoryCacheSettings

İadeler:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

İmza:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

Parametreler

Parametre Tip Tanım
ayarlar { cacheSizeBytes?: number; }

İadeler:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

İmza:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

Parametreler

Parametre Tip Tanım
ayarlar PersistentCacheSettings

İadeler:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

İmza:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

Parametreler

Parametre Tip Tanım
ayarlar PersistentSingleTabManagerSettings | Tanımsız Configures the created tab manager.

İadeler:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

İmza:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parametreler

Parametre Tip Tanım
enstantane fotoğraf DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to end at.

İadeler:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

İmza:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parametreler

Parametre Tip Tanım
enstantane fotoğraf DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to end before.

İadeler:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

İmza:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Parametreler

Parametre Tip Tanım
enstantane fotoğraf DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to start after.

İadeler:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

İmza:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Parametreler

Parametre Tip Tanım
enstantane fotoğraf DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to start at.

İadeler:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

İmza:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

İmza:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

İmza:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

İmza:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

İmza:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

İmza:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

DocumentChangeType

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

İmza:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

İmza:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

İmza:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

İmza:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

İmza:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

İmza:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

İmza:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

İmza:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

İmza:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

İlkel

Primitive types.

İmza:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

İmza:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

İmza:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , başlamak() , startAfter() , endBefore() , sonunda() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

İmza:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

SetOptions

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

İmza:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

TaskState

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

İmza:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -tip

İmza:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

Veriyi güncelle

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

İmza:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

İmza:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

İmza:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);