@firebase/firestore/lite

Fonksiyonlar

Sınıflar

Arayüzler

Takma Adları Yazın

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.

İmza:

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

Parametreler

İadeler:

Yangın deposu

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

getFirestore(uygulama, veritabanı kimliği)

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

Sağlanan FirebaseApp ile ilişkili mevcut Firestore örneğini döndürür . Hiçbir örnek mevcut değilse, varsayılan ayarlarla yeni bir örneği başlatır.

İmza:

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

Parametreler

İadeler:

Yangın deposu

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

startupizeFirestore(uygulama, ayarlar)

Sağlanan ayarlarla Cloud Firestore'un yeni bir örneğini başlatır. Yalnızca getFirestore() dahil diğer işlevlerden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. .

İmza:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

Parametreler

İadeler:

Yangın deposu

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

startupizeFirestore(uygulama, ayarlar, veritabanı kimliği)

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

Sağlanan ayarlarla Cloud Firestore'un yeni bir örneğini başlatır. Yalnızca getFirestore() dahil diğer işlevlerden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. .

İmza:

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

Parametreler

İadeler:

Yangın deposu

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

fonksiyon(ateş deposu, ...)

koleksiyon(firestore, yol, yolSegmentleri)

Belirtilen mutlak yoldaki koleksiyona başvuran bir CollectionReference örneği alır.

İmza:

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

Parametreler

İadeler:

KoleksiyonReferans < BelgeVerileri , BelgeVerileri >

CollectionReference örneği.

İstisnalar

Son yolun çift sayıda bölümü varsa ve bir koleksiyona işaret etmiyorsa.

koleksiyonGrubu(ateş deposu, koleksiyon kimliği)

Verilen koleksiyon kimliğine sahip bir koleksiyonda veya alt collectionId bulunan veritabanındaki 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

İadeler:

Sorgu < BelgeVerileri , BelgeVerileri >

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

İadeler:

geçersiz

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

İadeler:

Belge < DocumentData , DocumentData >

DocumentReference örneği.

İstisnalar

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

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

İ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.

sonlandır (firestore)

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

terminate() çağrıldıktan sonra yalnızca clearIndexedDbPersistence() işlevleri kullanılabilir. Başka herhangi bir işlev FirestoreError atacaktır . Fesih bekleyen yazıları iptal etmez ve sunucudan yanıt bekleyen vaatler çözülmez.

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

İmza:

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

Parametreler

İadeler:

Söz <void>

Örnek başarıyla feshedildiğ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.

Bu yazmaların sonucu, yalnızca iade edilen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

WriteBatch

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

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

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

sunucuTimestamp()

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 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

İadeler:

Yangın deposu

Sağlanan uygulamanın 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

İadeler:

Alan değeri

setDoc() veya updateDoc() çağrısında kullanılmak üzere FieldValue Sentinel

ArrayUnion (Elementler)

Sunucuya sunucuya zaten var olan herhangi bir dizi değeri ile verilen öğeleri bir araya getirmesini söyleyen setDoc () veya updatedoc () ile kullanılabilecek özel bir değer döndürür. Dizide halihazırda bulunmayan her belirtilen öğe sonuna eklenecektir. Değiştirilen alan zaten bir dizi değilse, tam olarak belirtilen öğeleri içeren bir dizi ile üzerine yazılır.

İmza:

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

Parametreler

İadeler:

Alan değeri

setDoc() veya updateDoc() çağrısında kullanılmak üzere FieldValue Sentinel .

fonksiyon(alan,...)

ortalama (alan)

Bir sorgunun sonuç kümesinde belirtilen bir alanın ortalamasını bir dizi belge üzerinden hesaplamak için kullanılabilecek bir AgregateField nesnesi oluşturun.

İmza:

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

Parametreler

İadeler:

Toplu <numara | null>

Toplam (Alan)

Bir sorgunun sonuç kümesindeki bir dizi belge üzerinden belirli bir alanın toplamını hesaplamak için kullanılabilecek bir AgregateField nesnesi oluşturun.

İmza:

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

Parametreler

İadeler:

Toplu <sayı>

Fonksiyon (FieldPath, ...)

Sipariş (FieldPath, TalitortionTr)

Sorgu sonucunu belirtilen alana, isteğe bağlı olarak yükselmek yerine azalan sırada sıralayan bir QueryOrderByConstraint oluşturur.

İmza:

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

Parametreler

İadeler:

Queryorderbyconstraint

Oluşturulan queryorderbyconstraint .

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 zorlayan bir QueryFieldFilterConstraint oluşturur.

İmza:

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

Parametreler

İadeler:

QueryFieldFilterConstraint

Oluşturulan QueryFieldFilterConstraint .

Fonksiyon (FieldValues, ...)

Endat (FieldValues)

Sorgunun sırasına göre verilen alanlarda sona erecek şekilde ayarlanan sonucu değiştiren bir queryendAconstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.

İmza:

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

Parametreler

İadeler:

QueryendatConstraint

QueryendatConstraint'e Geçmek İçin query()

EndBefore (FieldValues)

Sonuç kümesini, verilen alanlardan önce sorgunun sırasına göre sonuna kadar değiştiren bir queryendAconstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.

İmza:

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

Parametreler

İadeler:

QueryendatConstraint

QueryendatConstraint'e Geçmek İçin query()

Startafter (FieldValues)

Sonuç kümesini, verilen alanlardan sonra sorgunun sırasına göre başlatacak şekilde değiştiren bir queryStartatConstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.

İmza:

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

Parametreler

İadeler:

QuerystartatConstraint

QueryStartatConstraint , query() geçmek için

startat (fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlardan başlayacak şekilde değiştiren bir querystartatConstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.

İmza:

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

Parametreler

İadeler:

QuerystartatConstraint

QueryStartatConstraint , query() geçmek için .

işlev (sol, ...)

AgregateFieldEqual (sol, sağ)

İki 'agregatefield'i karşılaştırır Eşitlik örnekleri.

İmza:

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

Parametreler

İadeler:

boolean

agregatequerysnapshotequal (sol, sağ)

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

İki AggregateQuerySnapshot örneği, eşit ve aynı verileri karşılaştıran altta yatan sorgular varsa "eşit" olarak kabul edilir.

İmza:

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

Parametreler

İadeler:

boolean

Nesneler yukarıda tanımlandığı gibi "eşit" veya başka türlü false ise true .

queryEqual(sol, sağ)

Verilen sorgular aynı koleksiyona işaret ederse ve aynı kısıtlamaları uyguladığında true döndürür.

İmza:

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

Parametreler

İadeler:

boolean

Referanslar aynı Firestore veritabanında aynı konuma işaret ediyorsa.

Refequal (sol, sağ)

Sağlanan referanslar eşitse true 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

İadeler:

boolean

Referanslar aynı Firestore veritabanında aynı konuma işaret ediyorsa.

Snapshotequal (sol, sağ)

Sağlanan anlık görüntüler eşitse true 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

İadeler:

boolean

Anlık görüntüler eşitse doğru.

fonksiyon(limit, ...)

limit(limit)

Yalnızca ilk eşleşen belgeleri döndüren bir queryLimitConstraint oluşturur.

İmza:

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

Parametreler

İadeler:

Querylimitconstraint

Oluşturulan querylimitconstraint .

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 Maddesi belirtmelisiniz, aksi takdirde yürütme sırasında bir istisna atılacaktır.

İmza:

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

Parametreler

İadeler:

Querylimitconstraint

Oluşturulan querylimitconstraint .

işlev (loglevel, ...)

Setloglevel (Loglevel)

Bulut Firestore günlüklerinin (hata ayıklama, hata veya sessiz) meselesini ayarlar.

İmza:

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

Parametreler

İadeler:

geçersiz

işlev (n, ...)

artış(n)

Sunucuya verilen değere göre alanın geçerli değerini artırmasını söyleyen setDoc () veya updatedoc () ile kullanılabilecek özel bir değer döndürür.

İşlenen veya mevcut alan değeri yüzen nokta hassasiyetini kullanıyorsa, tüm aritmetik IEEE 754 anlambilimini takip eder. Her iki değer de tamsayılar ise, JavaScript'in güvenli sayı aralığının dışındaki değerler ( Number.MIN_SAFE_INTEGER - Number.MAX_SAFE_INTEGER ) ayrıca hassas kayıplara tabidir. Ayrıca, Firestore arka ucu tarafından işlendikten sonra, tüm tamsayı işlemleri -2^63 ve 2^63-1 arasında sınırlıdır.

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

İmza:

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

Parametreler

İadeler:

Alan değeri

setDoc() veya updateDoc() çağrısında kullanılmak üzere FieldValue Sentinel

işlev (sorgu, ...)

getAgregate (sorgu, agregatespec)

Belgeleri gerçekten indirmeden verilen sorgunun sonuç kümesindeki belgeler üzerindeki belirtilen toplamaları hesaplar.

Toplama yapmak için bu işlevi kullanmak etkilidir, çünkü belgelerin verileri değil, yalnızca son toplama değerleri indirilir. Bu işlev, sonuç setinin tamamen indirilmesi (binlerce belge) için hassas bir şekilde büyük olduğu durumlarda belgelerin toplamalarını gerçekleştirebilir.

İmza:

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

Parametreler

İadeler:

Promise < agregatequerysnapshot <Agregatespectype, appModelType, dbmodelType >>

Örnek

const aggregateSnapshot = await getAggregate(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;

getCount (sorgu)

Belgeleri gerçekten indirmeden verilen sorgunun sonuç kümesindeki belge sayısını hesaplar.

Belgeleri saymak için bu işlevi kullanmak etkilidir, çünkü yalnızca belgelerin verileri değil, son sayı indirilir. Bu işlev, sonuç kümesinin tamamen indirmek için çok büyük olduğu durumlarda belgeleri sayabilir (binlerce belge).

İmza:

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

Parametreler

İadeler:

Promise < agregatequerysnapshot <{Count: AgregateField <Suster>; }, AppModelType, dbmodelType >>

Sayımla çözülecek bir söz; Sayım snapshot.data().count burada snapshot , iade edilen sözün çözüldüğü AggregateQuerySnapshot .

getDocs (sorgu)

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

Sorgu daha önce yürütülmüş olsa bile, tüm sorgular doğrudan sunucu tarafından yürütülür. Son değişiklikler yalnızca arka uç tarafından zaten uygulanmışsa alınan sonuçlara yansıtılır. Müşteri çevrimdışı ise işlem başarısız olur. Daha önce önbelleğe alınmış sonucu ve yerel değişiklikleri görmek için tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz < querysnapshot <AppModelType, dbmodelType >>

Sorgunun sonuçlarıyla çözülecek bir söz.

Sorgu (Sorgu, CompositeFilter, QueryConstraints)

Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.

İmza:

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

Parametreler

İadeler:

Sorgu <AppModelType, dbmodelType>

İstisnalar

Sağlanan sorgu kısıtlamalarından herhangi biri mevcut veya yeni kısıtlamalarla birleştirilemezse.

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.

İmza:

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

Parametreler

İadeler:

Sorgu <AppModelType, dbmodelType>

İstisnalar

Sağlanan sorgu kısıtlamalarından herhangi biri mevcut veya yeni kısıtlamalarla birleştirilemezse.

işlev (queryConstraints, ...)

ve (QueryConstraints)

Verilen filtre kısıtlamalarının bir birleşimi olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir bağlaç filtresi, verilen tüm filtreleri karşılıyorsa bir belge içerir.

İmza:

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

Parametreler

İadeler:

QueryCompositeFilterConstraint

Yeni oluşturulan QueryCompositeFilterConstraint .

veya (QueryConstraints)

Verilen filtre kısıtlamalarının bir ayrıştırılması olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir ayrışma filtresi, verilen filtrelerden herhangi birini karşılıyorsa bir belge içerir.

İmza:

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

Parametreler

İadeler:

QueryCompositeFilterConstraint

Yeni oluşturulan QueryCompositeFilterConstraint .

işlev (referans, ...)

AddDoc (referans, veriler)

Verilen verilerle belirtilen CollectionReference referansına yeni bir belge ekleyin ve otomatik olarak bir belge kimliği atayın.

Bu yazının sonucu yalnızca döndürülen vaat çözülmesinden sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz < DocumentReference <AppModelType, dbmodelType >>

Bir Promise arka ucuna yazıldıktan sonra yeni oluşturulan belgeye işaret eden bir DocumentReference referansı ile çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

Koleksiyon (Referans, Yol, PathSegments)

Belirtilen göreceli yolda reference alt koleksiyonuna atıfta bulunan bir CollectionReference örneği alır.

İmza:

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

Parametreler

İadeler:

Toplama < DocumentData , DocumentData >

CollectionReference örneği.

İstisnalar

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

Koleksiyon (Referans, Yol, PathSegments)

Belirtilen göreceli yolda reference alt koleksiyonuna atıfta bulunan bir CollectionReference örneği alır.

İmza:

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

Parametreler

İadeler:

Toplama < DocumentData , DocumentData >

CollectionReference örneği.

İstisnalar

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

Deletedoc (referans)

Belirtilen DocumentReference tarafından atıfta bulunulan belgeyi siler .

Silme yalnızca iade edilen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, silme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz <void>

Belge arka uçtan başarıyla silindikten sonra bir Promise çözüldü.

Doc (referans, yol, yolsegmentler)

Belirtilen göreli yolda reference olarak bir belgeyi ifade eden bir DocumentReference örneği alır. Herhangi bir yol belirtilmezse, döndürülen DocumentReference için otomatik olarak oluşturulan benzersiz bir kimlik kullanılacaktır .

İmza:

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

Parametreler

İadeler:

Belge <AppModelType, dbmodelType>

DocumentReference örneği.

İstisnalar

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

Doc (referans, yol, yolsegmentler)

Belirtilen göreli yolda reference olarak bir belgeyi ifade eden bir DocumentReference örneği alır.

İmza:

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

Parametreler

İadeler:

Belge < DocumentData , DocumentData >

DocumentReference örneği.

İstisnalar

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

getDoc (referans)

Belirtilen belge referansıyla belirtilen belgeyi okur.

Belge daha önce okunmuş veya değiştirilmiş olsa bile, tüm belgeler doğrudan sunucudan getirilir. Son değişiklikler yalnızca arka uç tarafından zaten uygulanmışlarsa, alınan DocumentSnapshot yansıtılır. Müşteri çevrimdışı ise, okuma başarısız olur. Önbellekleme kullanmayı veya yerel değişiklikleri görmek isterseniz, lütfen tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz < DocumentsNapShot <AppModelType, dbmodelType >>

Mevcut belge içeriğini içeren bir DocumentSnapshot çözülmüş bir söz.

setDoc (referans, veriler)

Belirtilen DocumentReference tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse, oluşturulacaktır.

Bu yazının sonucu yalnızca döndürülen vaat çözülmesinden sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz <void>

Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

setDoc (referans, veri, seçenekler)

Belirtilen DocumentReference tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse, oluşturulacaktır. merge veya mergeFields sağlarsanız , sağlanan veriler mevcut bir belgede birleştirilebilir.

Bu yazının sonucu yalnızca döndürülen vaat çözülmesinden sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz <void>

Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

UpdateC (referans, veriler)

Belgedeki alanları, belirtilen DocumentReference referansıyla atıfta bulunun . Var olmayan bir belgeye uygulanırsa güncelleme başarısız olur.

Bu güncellemenin sonucu yalnızca döndürülen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, güncelleme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz <void>

Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli değilse, FIRESTORE verileri.

Updateoc (referans, alan, değer, mazeriye kanadvalues)

Belgedeki alanları, belirtilen DocumentReference tarafından atıfta bulunulan güncelleme, mevcut olmayan bir belgeye uygulanırsa güncelleme başarısız olur.

Yuvalanmış alanlar, nokta tarafından ayrılmış alan yolu dizeleri sağlayarak veya FieldPath nesneleri sağlayarak güncellenebilir.

Bu güncellemenin sonucu yalnızca döndürülen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, güncelleme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.

İmza:

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

Parametreler

İadeler:

Söz <void>

Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli değilse, FIRESTORE verileri.

Fonksiyon (Snapshot, ...)

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

Verilen belgede (dahil) sonucunu değiştiren bir queryendAconstraint oluşturur (dahil). Son konum sorgunun sırasına göre. Belge, sorgunun siparişinde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

İadeler:

QueryendatConstraint

QueryendatConstraint'e Geçmek İçin query()

EndBefore (Snapshot)

Verilen belgeden (özel) önce sonucunu değiştiren bir queryendAconstraint oluşturur (özel). Son konum sorgunun sırasına göre. Belge, sorgunun siparişinde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

İadeler:

QueryendatConstraint

QueryendatConstraint'e Geçmek İçin query()

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

Verilen belgeden sonra (özel) başlayacak olan sonucu değiştiren bir querystartatConstraint oluşturur. Başlangıç ​​konumu sorgunun sırasına göre. Belge, sorgunun siparişinde sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

İadeler:

QuerystartatConstraint

QueryStartatConstraint , query() geçmek için

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

Verilen belgede (dahil) başlayacak olan sonucu değiştiren bir queryStartatConstraint oluşturur. Başlangıç ​​konumu sorgunun sırasına göre. Belge, bu sorgunun orderBy sağlanan tüm alanları içermelidir.

İmza:

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

Parametreler

İadeler:

QuerystartatConstraint

QueryStartatConstraint , query() geçmek için .

Addprefixtokeys

Her anahtarın bir noktaya eklenen dış anahtarla önek olduğu 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];
};

AgregateFieldType

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

İmza:

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

Agregatespecdata

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

İmza:

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

AgregateType

Gerçekleştirilecek toplam türü temsil eden sendika tipi.

İmza:

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

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] sendika türlerini Record üzerine dağıtmak için kullanılır , çünkü T[K] bir ifade olarak değerlendirilir ve dağıtılmaz.

Bkz.

İmza:

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

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. - 'Durgun': 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.

İ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';

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

İmza:

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

Sipariş

Bir sipariş () maddesinin yönü 'desc' veya 'ASC' (azalan veya yükselen) olarak belirtilir.

İmza:

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

Kısmiwithfieldvalue

TypeScript'in Partial<T> , ancak iç içe geçmiş alanların atlanmasına ve mülk 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);

İlkel

İlkel türler.

İmza:

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

Sorgu Kısıtlaması Türü

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

İmza:

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

QueryFilterConstraint

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

İmza:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

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üzen () ç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 .

İmza:

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

Setoptions

SetDoc () davranışını yapılandıran bir seçenek nesnesi ve çağrılar. Bu çağrılar, bir SetOptions ile merge: true .

İmza:

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

UnionTointersection

Birlik tipi U = T1 | T2 | ... , kesişen bir tür 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-in-inditional-types https: https: https: -tip

İmza:

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

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.

İmza:

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

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'.

İmza:

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

WithfieldValue

Tür güvenliğini korurken alan değerlerinin bir özellik değeri olarak aktarılmasına izin verir.

İmza:

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