@firebase/firestore

İşlevler

Sınıflar

Arayüzler

Değişkenler

Tür Takma Adları

function(uygulama; ...)

getFirestore(uygulama)

Sağlanan FirebaseApp ile ilişkilendirilmiş mevcut varsayılan Firestore örneğini döndürür. Herhangi bir örnek yoksa varsayılan ayarlarla yeni bir örnek başlatır.

İmza:

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

Parametreler

Şunu döndürür:

Firestore

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

getFirestore(uygulama; veritabanı kimliği)

Bu API, geliştiriciler için önizleme olarak sunulmaktadı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şkilendirilmiş mevcut adlandırılmış Firestore örneğini döndürür. Herhangi bir örnek yoksa varsayılan ayarlarla yeni bir örnek başlatır.

İmza:

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

Parametreler

Şunu döndürür:

Firestore

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

startizeFirestore(uygulama; ayarlar, veritabanı kimliği)

Sağlanan ayarlarla yeni bir Firestore örneğini başlatır. Yalnızca diğer herhangi bir işlevden önce çağrılabilir (getFirestore() dahil). Ö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

Şunu döndürür:

Firestore

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

fonksiyon(firestore, ...)

clearIndexedDbPersistence(firestore)

Kalıcı depolama alanını temizler. Beklemedeki yazmalar ve önbelleğe alınan dokümanlar da buna dahildir.

Firestore örneği başlatılmadan çağrılmalıdır (uygulama sonlandırıldıktan sonra veya uygulama ilk kez başlatıldıktan sonra). Başlangıçta bu işlev, diğer işlevlerden (initializeFirestore() veya getFirestore() dışında) önce çağrılmalıdır. Firestore örneği hâlâ çalışıyorsa taahhüt reddedilir ve bu durumda failed-precondition hata kodu gösterilir.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Kalıcı depolama alanı temizlendiğinde çözümlenen bir Promise. Aksi takdirde, taahhüt bir hata mesajıyla reddedilir.

koleksiyon(firestore, yol, pathSegments)

Belirtilen mutlak yoldaki koleksiyonu ifade eden bir CollectionReference örneği alır.

İmza:

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

Parametreler

Şunu döndürür:

CollectionReference<DocumentData, DocumentData>

CollectionReference örneği.

İstisnalar

Son yolda çift sayıda segment varsa ve bir koleksiyona işaret etmiyorsa.

koleksiyonGrubu(firestore, collectionsId)

Veritabanında bulunan ve belirtilen collectionId değerine sahip bir koleksiyonda veya alt koleksiyonda yer alan tüm dokümanları 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

Şunu döndürür:

Sorgu<DocumentData, DocumentData>

Oluşturulan: Query.

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.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

devre dışı bırakma(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 anlık görüntü dinleyicileri, getDoc() veya getDocs() çağrıları önbellekten sonuçlar döndürür ve tüm yazma işlemleri, ağ geri yüklenene kadar sıraya alınır.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

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

doc(firestore, path; pathSegments)

Belirtilen mutlak yoldaki belgeye işaret eden bir DocumentReference örneği alır.

İmza:

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

Parametreler

Şunu döndürür:

DocumentReference<DocumentData, DocumentData>

DocumentReference örneği.

İstisnalar

Son yolda tek sayıda segment varsa ve bir dokümana işaret etmiyorsa.

allowIndexedDbPersistence(firestore, kalıcılıkAyarlar)

Bu işlev gelecekteki bir ana sürümde kaldırılacaktır. Bunun yerine, IndexedDb önbelleğini etkinleştirmek için FirestoreSettings.localCache öğesini PersistentLocalCache örneği olarak ayarlayın. FirestoreSettings.localCache zaten belirtilmişken bu işlevin çağrılması bir istisna oluşturur.

Mümkünse kalıcı depolamayı etkinleştirmeye çalışır.

Başarısız olması durumunda enableIndexedDbPersistence(), sözü reddeder veya bir istisna yapar. Bunun başarısız olmasının birkaç nedeni vardır. Bu neden, hatadaki code tarafından tespit edilebilir.

* failed-precondition: Uygulama zaten başka bir tarayıcı sekmesinde açık durumda. * uygulanmadı: Tarayıcı, çevrimdışı kalıcılık uygulamasıyla uyumlu değil.

Hata sonrasında bile Firestore örneğinin kullanılabilir durumda kalacağını ancak çevrimdışı kalıcılığın devre dışı bırakılacağını unutmayın.

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

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Kalıcı depolama alanının başarıyla etkinleştirilmesini temsil eden bir Promise.

allowMultiTabIndexedDbPersistence(firestore)

Bu işlev gelecekteki bir ana sürümde kaldırılacaktır. Bunun yerine, dizine eklenen veritabanı önbelleğini açmak için FirestoreSettings.localCache öğesini PersistentLocalCache örneği olarak ayarlayın. FirestoreSettings.localCache zaten belirtilmişken bu işlevin çağrılması bir istisna oluşturur.

Mümkünse çok sekmeli kalıcı depolamayı etkinleştirmeye çalışır. Tüm sekmelerde etkinleştirilirse tüm işlemler, tüm bağlı örneklerde sorguların ortak yürütülmesi ve gecikmeyi telafi eden yerel belge güncellemeleri dahil olmak üzere yerel kalıcılığa erişimi paylaşır.

Başarısız olması durumunda enableMultiTabIndexedDbPersistence(), sözü reddeder veya bir istisna yapar. Bunun başarısız olmasının birkaç nedeni vardır. Bu neden, hatadaki code tarafından tespit edilebilir.

* başarısız ön koş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.

Hata sonrasında bile Firestore örneğinin kullanılabilir durumda 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

Şunu döndürür:

Taahhüt<void>

Kalıcı depolama alanının başarıyla etkinleştirilmesini temsil eden bir Promise.

EtkinleştirmeAğı(firestore)

Önceki bir disableNetwork() çağrısından sonra bu Firestore örneği için ağ kullanımını yeniden etkinleştirir.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

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

getPersistentCacheIndexManager(firestore)

Belirtilen Firestore nesnesi tarafından kullanılan PersistentCache Dizin Yöneticisi'ni döndürür.

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

İmza:

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

Parametreler

Şunu döndürür:

PersistentCacheIndexManager | boş

loadBundle(firestore; BundleData)

Yerel önbelleğe bir Firestore paketi yükler.

İmza:

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

Parametreler

Şunu döndürür:

LoadBundleTask

Arayanlara ilerleme durumu güncellemelerini ve tamamlanma veya hata etkinliklerini bildiren bir LoadBundleTask nesnesi. Promise<LoadBundleTaskProgress> olarak kullanılabilir.

adlandırılmışSorgu(firestore; ad)

Belirtilen adla tanımlanan yerel önbellekten bir Firestore Sorgusu okur.

Adlandırılmış sorgular, sunucu tarafında paketler halinde paketlenir (sonuçlanan dokümanlarla birlikte) ve loadBundle kullanılarak yerel önbelleğe yüklenir. Yerel önbelleğe alındıktan sonra, bir Sorgu'yu ada göre ayıklamak için bu yöntemi kullanın.

İmza:

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

Parametreler

Şunu döndürür:

Söz<Sorgu | null>

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

onSnapshotsInSync(firestore, gözlemci)

Senkronize edilen anlık görüntüler etkinliği için bir işleyici ekler. Sync-in-sync etkinliği, sunucu tarafından oluşturulan tek bir değişiklik birden çok işleyiciyi etkilese bile belirli bir değişiklikten etkilenen tüm işleyicilerin tetiklendiğini gösterir.

NOT: Sync-in-sync etkinliği, yalnızca işleyicilerin birbiriyle senkronize olduğunu gösterir, ancak bu anlık görüntülerin sunucuyla senkronize olup olmamasıyla ilgili değildir. Bir anlık görüntünün önbellekten mi yoksa sunucudan mı geldiğini 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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshotsInSync(firestore, onSync)

Senkronize edilen anlık görüntüler etkinliği için bir işleyici ekler. Sync-in-sync etkinliği, sunucu tarafından oluşturulan tek bir değişiklik birden çok işleyiciyi etkilese bile belirli bir değişiklikten etkilenen tüm işleyicilerin tetiklendiğini gösterir.

NOT: Sync-in-sync etkinliği, yalnızca işleyicilerin birbiriyle senkronize olduğunu gösterir, ancak bu anlık görüntülerin sunucuyla senkronize olup olmamasıyla ilgili değildir. Bir anlık görüntünün önbellekten mi yoksa sunucudan mı geldiğini belirlemek için bağımsız işleyicilerde SnapshotMetadata kullanın.

İmza:

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

Parametreler

Şunu döndürür:

E-posta listesinden çık

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

runTransaction(firestore, updateFunction, seçenekler)

Belirtilen updateFunction işlemini yürütür ve ardından işlemde uygulanan değişiklikleri uygulamaya çalışır. İşlem kapsamında okunan herhangi bir belge değiştiyse Cloud Firestore, updateFunction yöntemini yeniden dener. 5 denemeden sonra başarısız olursa 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

Şunu döndürür:

Söz<T>

İşlem başarıyla tamamlanırsa veya açıkça iptal edilirse (updateFunction, başarısız bir söz verdiyse) updateFunction tarafından verilen taahhüt buraya döndürülür. Aksi takdirde, işlem başarısız olursa reddedilmiş bir taahhüt ve karşılık gelen hata hatası döndürülür.

setIndexConfiguration(firestore; yapılandırma)

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

Önbellek dizinlerini manuel olarak oluşturmak yerine, yerel olarak çalıştırılan sorgular için önbellek dizinleri oluşturup oluşturmama konusunda SDK'nın karar vermesine izin vermek amacıyla enablePersistentCacheIndexAutoCreation() kullanabilirsiniz.

Yerel sorgu yürütme için dizine eklemeyi yapılandırır. Önceki tüm dizin yapılandırmaları geçersiz kılınır. Dizin yapılandırması devam ettirildikten sonra Promise çözülür.

Dizin girişleri eşzamansız olarak oluşturulur. Dizinler henüz kullanılamıyor olsa bile dizine ekleme gerektiren sorguları kullanmaya devam edebilirsiniz. Sorgu yürütme, dizin girişleri yazıldıktan sonra otomatik olarak dizini kullanmaya başlar.

Dizinler yalnızca IndexedDb kalıcılığıyla desteklenir. IndexedDb etkin değilse dizin yapılandırması yok sayılır.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

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

İstisnalar

JSON biçimi geçersizse FirestoreError.

setIndexConfiguration(firestore, json)

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

Önbellek dizinlerini manuel olarak oluşturmak yerine, yerel olarak çalıştırılan sorgular için önbellek dizinleri oluşturup oluşturmama konusunda SDK'nın karar vermesine izin vermek amacıyla enablePersistentCacheIndexAutoCreation() kullanabilirsiniz.

Yerel sorgu yürütme için dizine eklemeyi yapılandırır. Önceki tüm dizin yapılandırmaları geçersiz kılınır. Dizin yapılandırması devam ettirildikten sonra Promise çözülür.

Dizin girişleri eşzamansız olarak oluşturulur. Dizinler henüz kullanılamıyor olsa bile dizine ekleme gerektiren sorguları kullanmaya devam edebilirsiniz. Sorgu yürütme, dizin girişleri yazıldıktan sonra otomatik olarak dizini kullanmaya başlar.

Dizinler yalnızca IndexedDb kalıcılığıyla desteklenir. Dizin yapılandırmasını ayarlamadan önce enableIndexedDbPersistence() veya enableMultiTabIndexedDbPersistence() çağırın. IndexedDb etkin değilse dizin yapılandırması yok sayılır.

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

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

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

İstisnalar

JSON biçimi geçersizse FirestoreError.

sonlandır(firestore)

Sağlanan Firestore örneğini sonlandırır.

terminate() çağrıldıktan sonra yalnızca clearIndexedDbPersistence() işlevi kullanılabilir. Diğer herhangi bir işlev FirestoreError gönderir.

Sonlandırmadan sonra yeniden başlatmak için getFirestore() ile yeni bir FirebaseFirestore örneği oluşturun.

Fesih işlemi, beklemedeki yazma işlemlerini iptal etmez ve sunucudan yanıt bekleyen taahhütler çözümlenmez. Kalıcılığı etkinleştirdiyseniz bu örneği bir sonraki başlatmanızda sunucu bu yazma işlemlerini sunucuya göndermeye devam eder.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Örnek başarıyla sonlandırıldığında çözülen bir Promise.

WaitForPendingWrites(firestore)

Etkin kullanıcı için bekleyen tüm yazmalar arka uç tarafından onaylanana kadar bekler.

Bekleyen yazma işlemi yoksa döndürülen taahhüt hemen çözümlenir. Aksi takdirde, taahhüt önceden verilmiş tüm yazmaları (önceki uygulama oturumunda yazılanlar da dahil) bekler, ancak işlev çağrıldıktan sonra eklenen yazmaları beklemez. Yazma işleminin daha fazla olmasını beklemek istiyorsanız waitForPendingWrites() yöntemini tekrar çağırın.

Bekleyen tüm waitForPendingWrites() taahhütleri kullanıcı değişiklikleri sırasında reddedilir.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Şu anda beklemede olan tüm yazmalar arka uç tarafından onaylandığında çözümlenen bir Promise.

WriteBatch(firestore)

Tek bir atomik işlem olarak birden fazla yazma işlemi gerçekleştirmek için kullanılan bir yazma grubu oluşturur. Tek bir WriteBatch içinde izin verilen maksimum yazma sayısı 500'dür.

İşlemlerden farklı olarak yazma grupları çevrimdışı olarak saklanır. Bu nedenle, yazmalarınızı okunan verilerde koşullandırmanız gerekmediğinde tercih edilir.

İmza:

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

Parametreler

Şunu döndürür:

WriteBatch

Birden fazla yazma işlemini otomatik olarak yürütmek için kullanılabilen bir WriteBatch.

fonksiyon()

count()

Sorgunun sonuç kümesindeki belge sayısını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.

İmza:

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

Şunu döndürür:

AggregateField<sayı>

deleteField()

Bir alanı silinmek üzere işaretlemek için updateDoc() veya setDoc() ile kullanılacak {merge: true} ile birlikte kullanılacak bir sentinel döndürür.

İmza:

export declare function deleteField(): FieldValue;

Şunu döndürür:

Alan Değeri

dokümanKimliği()

Bir dokümanın kimliğine başvuruda bulunmak için özel bir koruyucu FieldPath döndürür. Sorgularda doküman kimliğine göre sıralama veya filtreleme yapmak için kullanılabilir.

İmza:

export declare function documentId(): FieldPath;

Şunu döndürür:

FieldPath

getFirestore()

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

İmza:

export declare function getFirestore(): Firestore;

Şunu döndürür:

Firestore

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

bellekEagerGarbageCollector()

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

İmza:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Şunu döndürür:

MemoryEagerGarbageCollector

KalıcıMultipleTabManager()

PersistentMultipleTabManager öğesinin bir örneğini oluşturur.

İmza:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Şunu döndürür:

PersistentMultipleTabManager

sunucuZaman Damgası()

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;

Şunu döndürür:

Alan Değeri

function(veritabanıId; ...)

getFirestore(veritabanıKimliği)

Bu API, geliştiriciler için önizleme olarak sunulmaktadı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şkilendirilmiş mevcut adlandırılmış Firestore örneğini döndürür. Herhangi bir örnek yoksa varsayılan ayarlarla yeni bir örnek başlatır.

İmza:

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

Parametreler

Şunu döndürür:

Firestore

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

function(öğeler; ...)

stringRemove(öğeler)

setDoc() ile kullanılabilecek veya sunucuya, belirtilen öğeleri sunucuda zaten bulunan herhangi bir dizi değerinden kaldırmasını bildiren özel değeri döndürür. Belirtilen her bir öğenin tüm örnekleri diziden kaldırılır. Değiştirilen alan halihazırda bir dizi değilse boş bir diziyle bu alanın üzerine yazılır.

İmza:

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

Parametreler

Şunu döndürür:

Alan Değeri

setDoc() veya updateDoc() numaralı telefona yapılan bir çağrıda kullanılacak FieldValue koruyucu

diziUnion(öğeler)

setDoc() veya updateDoc() ile kullanılabilecek özel değeri döndürür. Bu değer, sunucuya belirtilen öğeleri sunucuda zaten mevcut olan herhangi bir dizi değeriyle birleştirmesini bildirir. Dizide mevcut olmayan belirtilen her bir öğe sona eklenir. Değiştirilen alan halihazırda bir dizi değilse, tam olarak belirtilen öğeleri içeren bir dizi bu alanın üzerine yazılır.

İmza:

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

Parametreler

Şunu döndürür:

Alan Değeri

setDoc() veya updateDoc() numaralı telefona yapılan bir çağrıda kullanılacak FieldValue koruyucu.

fonksiyon(alan; ...)

ortalama(alan)

Sorgunun sonuç grubundaki bir dizi belge üzerinde belirtilen bir alanın ortalamasını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.

İmza:

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

Parametreler

Şunu döndürür:

AggregateField<sayı | null>

sum(alan)

Sorgunun sonuç kümesindeki bir dizi belge üzerinde belirtilen bir alanın toplamını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.

İmza:

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

Parametreler

Şunu döndürür:

AggregateField<sayı>

function(fieldPath; ...)

orderBy(fieldPath;DirectionStr)

Sorgu sonucunu belirtilen alana göre ve isteğe bağlı olarak artan yerine azalan düzende sıralayan bir QueryOrdersByConstraint oluşturur.

İmza:

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

Parametreler

Şunu döndürür:

QueryOrderByConstraint

Oluşturulan Query OrderByConstraint.

nerede(fieldPath; opStr; değer)

Belgelerin belirtilen alanı içermesi ve değerin sağlanan ilişki kısıtlamasını karşılaması gerektiğini zorunlu kılan bir QueryFieldFilterConstraint oluşturur.

İmza:

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

Parametreler

Şunu döndürür:

QueryFieldFilterConstraint

Oluşturulan QueryFieldFilterConstraint.

function(fieldValues; ...)

endAt(fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlarda sona erecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

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

Parametreler

Şunu döndürür:

SorguBitişAkısıtlaması

query() öğesine iletilecek bir QueryEndAtConstraint

endBefore(fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlardan önce sona erecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

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

Parametreler

Şunu döndürür:

SorguBitişAkısıtlaması

query() öğesine iletilecek bir QueryEndAtConstraint

startAfter(fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlardan sonra başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

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

Parametreler

Şunu döndürür:

QueryStartAtConstraint (Sorgu Başlatma Kısıtlaması)

query() öğesine iletilecek QueryStartAtConstraint öğesi

startAt(fieldValues)

Sonuç kümesini sorgunun sırasına göre sağlanan alanlarda başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

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

Parametreler

Şunu döndürür:

QueryStartAtConstraint (Sorgu Başlatma Kısıtlaması)

query() öğesine iletilecek bir QueryStartAtConstraint.

function(indexManager; ...)

deleteAllPersistentCacheIndexes(indexManager)

Tüm kalıcı önbellek dizinlerini kaldırır.

Bu işlevin, desteği sonlandırılan setIndexConfiguration() tarafından oluşturulan dizinleri de sileceğini lütfen unutmayın.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

devre dışı bırakma PersistentCacheIndexAutoCreation(indexManager)

Yerel sorgu yürütme için kalıcı önbellek dizinlerini otomatik olarak oluşturmayı durdurur. enablePersistentCacheIndexAutoCreation() çağrısı yapılarak oluşturulan dizinler geçerli olmaya devam eder.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

allowPersistentCacheIndexAutoCreation(indexManager)

SDK, önbellek dizinlerinin performansı iyileştirmeye yardımcı olabileceğini düşünüyorsa SDK'nın yerel sorgu yürütme için otomatik olarak kalıcı önbellek dizinleri oluşturmasını sağlar.

Bu özellik varsayılan olarak devre dışıdır.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

işlev(sol; ...)

totalFieldEqual(sol; sağ)

Eşitlik için iki "AggregateField" örneğini karşılaştırır.

İmza:

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

Parametreler

Şunu döndürür:

boolean

totalQuerySnapshotEqual(sol, sağ)

Eşitlik için iki AggregateQuerySnapshot örneğini karşılaştırır.

İki AggregateQuerySnapshot örneği "eşit" olarak kabul edilir ve aynı verileri karşılaştıran temel sorguları olup olmadığını gösterir.

İmza:

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

Parametreler

Şunu döndürür:

boolean

Nesneler yukarıda tanımlandığı gibi "eşit"se true, aksi takdirde false.

queryEqual(sol; sağ)

Sağlanan sorgular aynı koleksiyonu işaret ederse ve aynı kısıtlamaları uygularsa true değerini döndürür.

İmza:

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

Parametreler

Şunu döndürür:

boolean

Referanslar aynı Firestore veritabanında aynı konumu işaret ediyorsa true

refEqual(sol; sağ)

Sağlanan referanslar eşitse true değerini döndürür.

İ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

Şunu döndürür:

boolean

Referanslar aynı Firestore veritabanında aynı konumu işaret ediyorsa true

SnapshotEqual(sol, sağ)

Sağlanan anlık görüntüler eşitse true değerini döndürür.

İ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

Şunu döndürür:

boolean

anlık görüntüler eşitse true.

function(sınır; ...)

limit(limit)

Yalnızca ilk eşleşen dokümanları döndüren bir QueryLimitConstraint oluşturur.

İmza:

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

Parametreler

Şunu döndürür:

QueryLimitConstraint

Oluşturulan QueryLimitConstraint.

limitToLast(sınır)

Yalnızca son eşleşen dokümanları döndüren bir QueryLimitConstraint oluşturur.

limitToLast sorguları için en az bir orderBy ifadesi belirtmeniz gerekir, aksi takdirde yürütme sırasında bir istisna oluşur.

İmza:

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

Parametreler

Şunu döndürür:

QueryLimitConstraint

Oluşturulan QueryLimitConstraint.

function(logLevel; ...)

setLogLevel(logLevel)

Cloud Firestore günlüklerinin ayrıntısını ayarlar (hata ayıklama, hata veya sessiz).

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

işlev(n; ...)

artış(n)

setDoc() veya updateDoc() ile kullanılabilecek özel değeri döndürür. Bu değer, sunucuya alanın geçerli değerini verilen değere göre artırmasını bildirir.

İşlenen veya geçerli alan değeri kayan nokta kesinliğini kullanıyorsa tüm aritmetikler IEEE 754 anlamını izler. Her iki değer de tam sayıysa JavaScript'in güvenli sayı aralığının (Number.MIN_SAFE_INTEGER - Number.MAX_SAFE_INTEGER) dışındaki değerler de kesinlik kaybına tabi olur. Ayrıca, Firestore arka ucu tarafından işlendikten sonra tüm tam sayı işlemleri -2^63 ile 2^63-1 arasında sınırlandırılır.

Geçerli alan değeri number türünde değilse veya alan henüz mevcut değilse dönüşüm işlemi, alanı verilen değere ayarlar.

İmza:

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

Parametreler

Şunu döndürür:

Alan Değeri

setDoc() veya updateDoc() numaralı telefona yapılan bir çağrıda kullanılacak FieldValue koruyucu

function(sorgu; ...)

getAggregateFromServer(sorgu, aggregateSpec)

Belgeleri indirmeden, belirtilen sorgunun sonuç kümesindeki dokümanlar üzerinden belirtilen toplamaları hesaplar.

Dokümanların değil yalnızca nihai toplama değerleri geçerli olduğundan, toplama işlemleri için bu işlevin kullanılması verimlidir. indirilerek oluşturulur. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda (binlerce doküman) belgeleri toplama işlemini gerçekleştirebilir.

Sunucudan alınan sonuç, herhangi bir yerel durum dikkate alınmaksızın, değiştirilmeden sunulur. Diğer bir deyişle, yerel önbellekteki dokümanlar ve henüz sunucuyla senkronize edilmemiş yerel değişiklikler dikkate alınmaz. Daha önce indirilen sonuçlar (varsa) kullanılmaz. Bu işlevin her çağrılması zorunlu olarak sunucuya bir gidiş dönüşü içerir.

İmza:

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

Parametreler

Şunu döndürür:

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(sorgu)

Belirli bir sorgunun sonuç kümesindeki dokümanların sayısını, dokümanları indirmeden hesaplar.

Dokümanları saymak için bu işlevi kullanmak verimlidir çünkü dokümanların sayımında değil, indirilerek yüklenir. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda dokümanları da sayabilir (binlerce doküman).

Sunucudan alınan sonuç, herhangi bir yerel durum dikkate alınmaksızın, değiştirilmeden sunulur. Diğer bir deyişle, yerel önbellekteki dokümanlar ve henüz sunucuyla senkronize edilmemiş yerel değişiklikler dikkate alınmaz. Daha önce indirilen sonuçlar (varsa) kullanılmaz. Bu işlevin her çağrılması zorunlu olarak sunucuya bir gidiş dönüşü içerir.

İmza:

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

Parametreler

Şunu döndürür:

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

Sayıyla birlikte sonuçlanacak bir Taahhüt; Sayı, snapshot.data().count konumundan alınabilir. Burada snapshot, döndürülen Vaat'in çözdüğü AggregateQuerySnapshot değeridir.

getDokümanlar(sorgu)

Sorguyu yürütür ve sonuçları bir QuerySnapshot olarak döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Promise<QuerySnapshot<AppModelType, DbModelType>>

Sorgunun sonuçlarıyla çözümlenecek Promise.

getDokümanlarFromCache(sorgu)

Sorguyu yürütür ve sonuçları önbellekten bir QuerySnapshot olarak döndürür. Sorguyla eşleşen hiçbir doküman önbelleğe alınmışsa boş bir sonuç kümesi döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Promise<QuerySnapshot<AppModelType, DbModelType>>

Sorgunun sonuçlarıyla çözümlenecek Promise.

getDokümanlarFromServer(sorgu)

Sorguyu yürütür ve sonuçları sunucudan bir QuerySnapshot olarak döndürür. Ağ mevcut değilse bir hata döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Promise<QuerySnapshot<AppModelType, DbModelType>>

Sorgunun sonuçlarıyla çözümlenecek Promise.

onSnapshot(sorgu; gözlemleyici)

QuerySnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz. İşleyici, onSnapshot çağrıldığında döndürülen işlev çağrılarak iptal edilebilir.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshot(sorgu; seçenekler; gözlemci)

QuerySnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz. İşleyici, onSnapshot çağrıldığında döndürülen işlev çağrılarak iptal edilebilir.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshot(sorgu; onNext; onError; onComplete)

QuerySnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz. İşleyici, onSnapshot çağrıldığında döndürülen işlev çağrılarak iptal edilebilir.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshot(sorgu; seçenekler; onNext; onError; onComplete)

QuerySnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz. İşleyici, onSnapshot çağrıldığında döndürülen işlev çağrılarak iptal edilebilir.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

sorgu(sorgu; bileşen Filtresi; queryConstraints)

Ek sorgu kısıtlamaları içerecek şekilde genişletilen yeni bir sabit Query örneğini oluşturur.

İmza:

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

Parametreler

Şunu döndürür:

Sorgu<AppModelType, DbModelType>

İstisnalar

değerini girin.

sorgu(sorgu; queryConstraints)

Ek sorgu kısıtlamaları içerecek şekilde genişletilen yeni bir sabit Query örneğini oluşturur.

İmza:

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

Parametreler

Şunu döndürür:

Sorgu<AppModelType, DbModelType>

İstisnalar

değerini girin.

function(queryConstraints, ...)

and(queryConstraints)

Belirtilen filtre kısıtlamalarının bir birleşimi olan yeni bir QueryCompositeFilterConstraint oluşturur. Bağlaç filtreleri, belirtilen tüm filtreleri karşılıyorsa dokümanı içerir.

İmza:

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

Parametreler

Şunu döndürür:

QueryCompositeFilterConstraint

Yeni oluşturulan QueryCompositeFilterConstraint.

veya(queryConstraints)

Belirtilen filtre kısıtlamalarının ayırması olan yeni bir QueryCompositeFilterConstraint oluşturur. Ayırma filtreleri, belirtilen filtrelerden herhangi birine uyan dokümanı içerir.

İmza:

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

Parametreler

Şunu döndürür:

QueryCompositeFilterConstraint

Yeni oluşturulan QueryCompositeFilterConstraint.

fonksiyon(başvuru; ...)

addDoc(başvuru; veriler)

Belirtilen CollectionReference için belirtilen verilerle yeni bir doküman ekleyin ve bu dokümana otomatik olarak doküman kimliği atayın.

İmza:

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

Parametreler

Şunu döndürür:

Promise<DocumentReference<AppModelType, DbModelType>>

Promise, arka uca yazıldıktan sonra yeni oluşturulan dokümanı işaret eden DocumentReference ile çözüldü (Çevrimdışı olduğunuzda çözümlenmeyeceğini unutmayın).

koleksiyon(referans, yol, yolSegmentleri)

Belirtilen göreli yoldaki bir reference alt koleksiyonuna referans veren CollectionReference örneğini alır.

İmza:

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

Parametreler

Şunu döndürür:

CollectionReference<DocumentData, DocumentData>

CollectionReference örneği.

İstisnalar

Son yolda çift sayıda segment varsa ve bir koleksiyona işaret etmiyorsa.

koleksiyon(referans, yol, yolSegmentleri)

Belirtilen göreli yoldaki bir reference alt koleksiyonuna referans veren CollectionReference örneğini alır.

İmza:

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

Parametreler

Şunu döndürür:

CollectionReference<DocumentData, DocumentData>

CollectionReference örneği.

İstisnalar

Son yolda çift sayıda segment varsa ve bir koleksiyona işaret etmiyorsa.

deleteDoc(başvuru)

Belirtilen DocumentReference tarafından atıfta bulunulan dokümanı siler.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Doküman arka uçtan başarıyla silindikten sonra bir Vaat çözümlendi (çevrimdışı olduğunuzda çözümlenmeyeceğini unutmayın).

doc(başvuru; yol; yolSegmentleri)

Belirtilen göreli yolda reference içindeki bir dokümana referans veren DocumentReference örneğini alır. Herhangi bir yol belirtilmezse döndürülen DocumentReference için otomatik olarak oluşturulmuş benzersiz bir kimlik kullanılır.

İmza:

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

Parametreler

Şunu döndürür:

DocumentReference<AppModelType, DbModelType>

DocumentReference örneği.

İstisnalar

Son yolda tek sayıda segment varsa ve bir dokümana işaret etmiyorsa.

doc(başvuru; yol; yolSegmentleri)

Belirtilen göreli yolda reference içindeki bir dokümana referans veren DocumentReference örneğini alır.

İmza:

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

Parametreler

Şunu döndürür:

DocumentReference<DocumentData, DocumentData>

DocumentReference örneği.

İstisnalar

Son yolda tek sayıda segment varsa ve bir dokümana işaret etmiyorsa.

getDoc(başvuru)

Bu DocumentReference tarafından atıfta bulunulan dokümanı okur.

İmza:

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

Parametreler

Şunu döndürür:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Bir söz, mevcut doküman içeriğini içeren bir DocumentSnapshot ile çözümlendi.

getDocFromCache(referans)

Bu DocumentReference tarafından başvuruda bulunulan dokümanı önbellekten okur. Doküman şu anda önbelleğe alınmış değilse bir hata döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Promise, mevcut doküman içeriğini içeren bir DocumentSnapshot ile çözümlendi.

getDocFromServer(başvuru)

Bu DocumentReference tarafından başvuruda bulunulan dokümanı sunucudan okur. Ağ mevcut değilse bir hata döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Promise, mevcut doküman içeriğini içeren bir DocumentSnapshot ile çözümlendi.

onSnapshot(başvuru; gözlemci)

DocumentSnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshot(başvuru; seçenekler; gözlemci)

DocumentSnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshot(referans, onNext, onError; onComplete)

DocumentSnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

onSnapshot(referans; seçenekler, onNext, onError; onComplete)

DocumentSnapshot etkinlikleri için bir işleyici ekler. Tek tek onNext ve onError geri çağırmalarını iletebilir veya next ve error geri çağırmalarıyla tek bir gözlemci nesnesini iletebilirsiniz.

NOT: onCompletion geri çağırması yapılabilse de anlık görüntü akışı hiç bitmeyen bir işlem olduğundan çağrı asla çağrılmaz.

İ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

Şunu döndürür:

E-posta listesinden çık

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

setDoc(başvuru; veri)

Bu DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü (çevrimdışı olduğunuzda çözümlenmeyeceğini unutmayın).

setDoc(başvuru; veriler; seçenekler)

Belirtilen DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur. merge veya mergeFields sağlarsanız, sağlanan veriler mevcut bir belgede birleştirilebilir.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Vaat çözümlendi (çevrimdışı olduğunuzda çözümlenmeyeceğini unutmayın).

updateDoc(başvuru; veri)

Dokümanda, belirtilen DocumentReference tarafından belirtilen alanları günceller. Mevcut olmayan bir dokümana uygulanırsa güncelleme başarısız olur.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü (çevrimdışı olduğunuzda çözümlenmeyeceğini unutmayın).

updateDoc(başvuru; alan; değer; moreFieldsAndValues)

Belirtilen DocumentReference tarafından atıfta bulunulan dokümandaki güncelleme alanları , mevcut olmayan bir dokümana uygulanırsa güncelleme başarısız olur.

İç içe geçmiş alanlar, noktayla ayrılmış alan yolu dizeleri veya FieldPath nesneleri sağlanarak güncellenebilir.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü (çevrimdışı olduğunuzda çözümlenmeyeceğini unutmayın).

function(ayarlar; ...)

bellekLocalCache(ayarlar)

MemoryLocalCache öğesinin bir örneğini oluşturur. Örnek, SDK'ya hangi önbellek katmanının kullanılacağını bildirmek için FirestoreSettings.cache olarak ayarlanabilir.

İmza:

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

Parametreler

Şunu döndürür:

MemoryLocalCache

bellekLruGarbageCollector(ayarlar)

MemoryLruGarbageCollector öğesinin bir örneğini oluşturur.

Hedef boyutu, ayar parametresinin parçası olarak belirtilebilir. Önbellek boyutu belirtilen boyutu aştığında toplayıcı, dokümanları silmeye başlar. Varsayılan önbellek boyutu 40 MB'tır (40 * 1024 * 1024 bayt).

İmza:

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

Parametreler

Şunu döndürür:

MemoryLruGarbageCollector

periyodikLocalCache(ayarlar)

PersistentLocalCache öğesinin bir ö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.

İmza:

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

Parametreler

Şunu döndürür:

PersistentLocalCache

kalıcıTekSekmeManager(ayarlar)

PersistentSingleTabManager öğesinin bir örneğini oluşturur.

İmza:

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

Parametreler

Şunu döndürür:

PersistentSingleTabManager

Functions(anlık görüntü; ...)

endAt(anlık görüntü)

Sonuç grubunu, sağlanan belgede (dahil) sona erecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu, sorgunun sırasına göre değişir. Belge, sorgunun OrderBy bölümünde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

Şunu döndürür:

SorguBitişAkısıtlaması

query() öğesine iletilecek bir QueryEndAtConstraint

endBefore(anlık görüntü)

Sonuç grubunu, sağlanan dokümandan (hariç) önce bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu, sorgunun sırasına göre değişir. Belge, sorgunun OrderBy bölümünde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

Şunu döndürür:

SorguBitişAkısıtlaması

query() öğesine iletilecek bir QueryEndAtConstraint

startAfter(anlık görüntü)

Sonuç grubunu, sağlanan dokümandan (hariç) sonra başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Başlangıç konumu, sorgunun sırasına göre değişir. Belge, sorgunun OrderBy bölümünde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

Şunu döndürür:

QueryStartAtConstraint (Sorgu Başlatma Kısıtlaması)

query() öğesine iletilecek QueryStartAtConstraint öğesi

startAt(anlık görüntü)

Sonuç grubunu, sağlanan belgede (dahil) başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Başlangıç konumu, sorgunun sırasına göre değişir. Belge, bu sorgunun orderBy bölümünde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

Şunu döndürür:

QueryStartAtConstraint (Sorgu Başlatma Kısıtlaması)

query() öğesine iletilecek bir QueryStartAtConstraint.

function(değerler; ...)

vektör(değerler)

Belirtilen sayı dizisinin bir kopyasıyla oluşturulan yeni bir VectorValue oluşturur.

İmza:

export declare function vector(values?: number[]): VectorValue;

Parametreler

Şunu döndürür:

VektörDeğeri

Belirtilen sayı dizisinin bir kopyasıyla oluşturulan yeni bir VectorValue.

SINIRSIZ BOYUTLU_BOYUT

LRU atık toplamayı belirtmek için kullanılan sabit değer devre dışı bırakılmalıdır. Bu değeri, Firestore örneğine iletilen ayarlarda cacheSizeBytes olarak belirleyin.

İmza:

CACHE_SIZE_UNLIMITED = -1

Anahtarlara Önek Ekle

Her anahtarın önüne dış anahtarın bir nokta eklenerek eklendiği yeni bir harita döndürür.

İ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

Firestore tarafından desteklenen tüm AggregateField türlerinin birleşimi.

İmza:

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

AggregateSpecData verileri

Anahtarları bir AggregateSpec öğesinden alınan ve değerleri, AggregateSpec girişinden karşılık gelen AggregateField tarafından gerçekleştirilen toplamanın sonucu olan bir tür.

İmza:

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

Toplama Türü

Gerçekleştirilecek toplama türünü temsil eden birleştirme türü.

İmza:

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

ChildUpdateFields

Belirli bir T1 türü için iç içe yerleştirilmiş alanları hesaplama yardımcısı. Bu, undefined | {...} (isteğe bağlı öğeler için geçerlidir) veya {a: A} | {b: B} gibi birlik türlerini dağıtmak için gereklidir.

Bu kullanım örneğinde, T[K] bir ifade olarak değerlendirildiği ve dağıtılmadığından, Record üzerinde T[K] birleşik türlerini dağıtmak için V kullanılır.

https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types adresine göz atın.

İmza:

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

Doküman Değişiklik Türü

DocumentChange türü "eklendi", "kaldırıldı" veya "değiştirildi" olabilir.

İmza:

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

Firestore Hata Kodu

Firestore durum kodları grubu. Kodlar, gRPC tarafından sunulan kodlarda aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Olası değerler: - 'cancelled': İşlem iptal edildi (genellikle çağrı yapan tarafından). - 'unknown': Bilinmeyen hata veya farklı bir hata alanından gelen hata. - 'geçersiz-bağımsız değişken': İstemci, geçersiz bir bağımsız değişken belirtti. Bunun "başarısız ön koşul"dan farklı olduğunu unutmayın. "geçersiz-bağımsız-argüman" sistemin durumundan bağımsız olarak sorunlu olan bağımsız değişkenleri belirtir (ör. geçersiz alan adı). - "deadline-exceeded" (son tarih-aşıldı): İşlem tamamlanamadan son tarih geçti. Sistemin durumunu değiştiren işlemlerde, işlem başarıyla tamamlanmış olsa bile bu hata döndürülebilir. Örneğin, bir sunucudan gelen başarılı bir yanıt, son tarihin dolmasına yetecek kadar gecikmiş olabilir. - 'not-found': İstenen dokümanlardan bazıları bulunamadı. - "zaten var": Oluşturmaya çalıştığımız bazı dokümanlar zaten mevcut. - "izin reddedildi": Arayanın belirtilen işlemi yürütme izni yok. - "Kaynak tükendi": Bazı kaynaklar tükendi (ör. kullanıcı başına belirlenen kota). veya dosya sisteminin tamamında alan kalmamış olabilir. - "failed-precondition" (başarısız-ön koşul): Sistem, işlemin yürütülmesi için gereken durumda olmadığından işlem reddedildi. - "iptal edildi": İşlem, genellikle işlemin iptalleri gibi eşzamanlılık sorunu nedeniyle iptal edildi. - "aralık dışında": İşlem, geçerli aralığın dışına çıkmaya çalışıldı. - 'uygulanmadı': İşlem uygulanmadı veya desteklenmiyor/etkinleştirilmedi. - 'internal': Dahili hatalar. Temel sistem tarafından beklenen bazı sabit değerlerin bozulduğu anlamına gelir. Bu hatalardan birini görürseniz bir şeyler çok bozuk demektir. - 'kullanılamıyor': Hizmet şu anda kullanılamıyor. Bu durum büyük olasılıkla geçici bir durumdur ve geri alma işlemiyle tekrar deneyerek düzeltilebilir. - "veri kaybı": Kurtarılamayan veri kaybı veya bozulması. - 'unauthenticated': İsteğin, işlemle ilgili geçerli kimlik doğrulama kimlik bilgileri yok.

İ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

Desteklenen tüm SDK önbellek katmanındaki birleştirme türü.

İmza:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenKaynağı

Sorgunun dinlediği kaynağı açıklayın.

Önbellek ve sunucu değişikliklerini dinlemek için default olarak ayarlayın. Yalnızca önbellekteki değişiklikleri dinlemek için cache olarak ayarlayın.

İmza:

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

BellekGarbageToplayıcı

Tüm yerel önbellek için atık toplayıcıları destekleyen birleştirme türü.

İmza:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

İç içe geçmişUpdateFields

Her alan (ör. "bar") için iç içe yerleştirilmiş tüm anahtarları bulun (ör. {'bar.baz': T1, 'bar.qux': T2}). Hepsi isteğe bağlı olarak işaretlenmiş olası tüm anahtarları içeren tek bir harita oluşturmak için bunları kesiştirin.

İmza:

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

Yöne Göre Sırala

orderBy() yan tümcesinin yönü "desc" olarak belirtilir veya "artan" (azalan veya artan).

İmza:

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

Alan Değeriyle Kısmi

TypeScript'in Partial<T> işlevine benzer, ancak iç içe yerleştirilmiş alanların atlanmasına ve FieldValues'un özellik değerleri olarak aktarılmasına izin verir.

İmza:

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

PersistentTabManager

Mevcut tüm sekme yöneticilerinin birliği.

İmza:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Temel

Temel türler.

İmza:

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

Sorgu SınırlamasıTürü

Bu SDK'da kullanılabilen farklı sorgu kısıtlamalarını açıklar.

İmza:

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

Sorgu Filtresi Kısıtlaması

QueryFilterConstraint, QueryFieldFilterConstraint ve QueryCompositeFilterConstraint'i temsil eden bir yardımcı birleştirme türüdür.

İmza:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

FiltreNonFiltre Kısıtlaması

QueryNonFilterConstraint, doküman grubunu daraltmak veya sıralamak için kullanılan ancak belge alanında açık bir şekilde filtreleme yapmayan Sorgu Kısıtlamalarını temsil eden bir yardımcı birleştirme türüdür. QueryNonFilterConstraint'ler orderBy(), startAt(), startAfter(), endBefore(), endAt(), limit() veya limitToLast() çağrılmasıyla oluşturulur ve ardından yeni sorgu oluşturmak için query() query() örneğine iletilebilir.QueryConstraint

İmza:

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

Ayar Seçenekleri

setDoc() işlevinin ve çağrıların davranışını yapılandıran bir seçenekler nesnesi. Bu çağrılar, merge: true özelliğine sahip bir SetOptions sağlanarak hedef dokümanların üzerine yazılmak yerine ayrıntılı birleştirme işlemleri gerçekleştirecek şekilde yapılandırılabilir.

İmza:

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

Görev Durumu

Paket yükleme görevlerinin durumunu temsil eder.

Her ikisi de "Hata" ve "Başarı" batma durumu: Görev iptal edilir veya tamamlanır. Bunlar bildirildikten sonra başka güncelleme yapılmaz.

İmza:

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

BirleşimdenKesişim'e

Birleştirme türü verilen U = T1 | T2 | ..., kesişen (T1 & T2 & ...) türünü döndürür.

Dağıtılabilir koşullu türleri ve koşullu türlerden çıkarımı kullanır. Bunun nedeni, zıt varyantlı konumlarda aynı tür değişken için birden fazla adayın bir kesişim türünün tahmin edilmesine neden olmasıdır. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/convert-union-type-to-intersection-type

İmza:

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