@firebase/firestore

کارکرد

کلاس ها

رابط ها

متغیرها

نام مستعار را تایپ کنید

عملکرد (برنامه ، ...)

GetFirestore (برنامه)

نمونه Firestore پیش فرض موجود را که با Firebaseapp ارائه شده همراه است ، برمی گرداند . اگر نمونه ای وجود نداشته باشد ، نمونه جدیدی را با تنظیمات پیش فرض آغاز می کند.

امضا:

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

مولفه های

برمی‌گرداند:

آتش نشانی

نمونه پیش فرض Firestore از برنامه ارائه شده.

getFirestore (برنامه ، databaseid)

این API به عنوان پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است براساس بازخوردی که دریافت می کنیم تغییر کند. از این API در یک محیط تولید استفاده نکنید.

نمونه Firestore موجود موجود را که با Firebaseapp ارائه شده همراه است ، برمی گرداند . اگر نمونه ای وجود نداشته باشد ، نمونه جدیدی را با تنظیمات پیش فرض آغاز می کند.

امضا:

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

مولفه های

برمی‌گرداند:

آتش نشانی

نمونه Firestore نامگذاری شده از برنامه ارائه شده.

InitializeFirestore (برنامه ، تنظیمات ، DatabaseId)

با تنظیمات ارائه شده ، نمونه جدیدی از Firestore را آغاز می کند. فقط می توان قبل از هر عملکرد دیگری ، از جمله GetFirestore () فراخوانده شد . اگر تنظیمات سفارشی خالی باشد ، این عملکرد معادل فراخوانی GetFirestore () است .

امضا:

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

مولفه های

برمی‌گرداند:

آتش نشانی

نمونه ای از آتش سوزی تازه اولیه.

عملکرد (آتش نشانی ، ...)

ClearIndexedDbpersistion (Firestore)

ذخیره مداوم را پاک می کند. این شامل نوشتن در انتظار و اسناد ذخیره شده است.

باید در حالی که نمونه Firestore شروع نشده است (پس از خاتمه برنامه یا اولین بار برنامه) فراخوانی شود. در هنگام راه اندازی ، این عملکرد باید قبل از سایر توابع (غیر از InitializeFirestore () یا GetFirestore () فراخوانی شود. )). اگر نمونه Firestore هنوز در حال اجرا باشد ، قول با کد خطای failed-precondition رد می شود .

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که هنگام پاک شدن ذخیره مداوم برطرف می شود. در غیر این صورت ، قول با یک خطا رد می شود.

مجموعه (Firestore ، Path ، Pathsegments)

یک نمونه CollectionReference است که به مجموعه در مسیر مطلق مشخص شده اشاره دارد.

امضا:

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

مولفه های

برمی‌گرداند:

بازپرداخت < DocumentData ، documentdata >

نمونه CollectionReference .

استثناها

اگر مسیر نهایی دارای تعداد حتی بخش هایی باشد و به یک مجموعه اشاره نمی کند.

گروه مجموعه (Firestore ، CollectionID)

یک نمونه Query جدیدی را ایجاد و باز می گرداند که شامل کلیه اسناد موجود در پایگاه داده است که در یک مجموعه یا زیر مجموعه با collectionId داده شده موجود است .

امضا:

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

مولفه های

برمی‌گرداند:

پرس و جو < DocumentData ، documentdata >

Query ایجاد شده .

ConnectFirestoreEmulator (Firestore ، Host ، Port ، گزینه ها)

این نمونه را برای برقراری ارتباط با شبیه ساز Firestore Cloud اصلاح کنید.

امضا:

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

مولفه های

برمی‌گرداند:

خالی

Disableenetwork (Firestore)

استفاده از شبکه را برای این مثال غیرفعال می کند. می توان آن را از طریق Enablenetwork دوباره فعال کرد () . در حالی که این شبکه غیرفعال است ، هرگونه شنونده عکس فوری ، getDoc() یا getDocs() نتایج حاصل از حافظه نهان را برمی گرداند و هرگونه عملیات نوشتن تا زمان ترمیم شبکه صف می شود.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که پس از غیرفعال شدن شبکه حل می شود.

DOC (Firestore ، Path ، Pathsegments)

یک نمونه DocumentReference می شود که به سند در مسیر مطلق مشخص شده اشاره دارد.

امضا:

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

مولفه های

برمی‌گرداند:

مرجع مستندات < DocumentData ، documentdata >

نمونه DocumentReference .

استثناها

اگر مسیر نهایی تعداد عجیب و غریب از بخش ها داشته باشد و به یک سند اشاره نمی کند.

EnableIndexedDbpersistion (Firestore ، Plastencesettings)

این عملکرد در نسخه اصلی آینده حذف خواهد شد. در عوض ، FirestoreSettings.localCache به عنوان نمونه ای از PersistentLocalCache تنظیم کنید تا حافظه نهان IndexedDB را روشن کنید. فراخوانی این عملکرد هنگامی که FirestoreSettings.localCache از قبل مشخص شده است ، یک استثنا را به وجود می آورد.

در صورت امکان تلاش برای فعال کردن ذخیره مداوم.

در صورت عدم موفقیت ، enableIndexedDbPersistence() قول را رد می کند یا یک استثنا را پرتاب می کند. دلایل مختلفی وجود دارد که این امر می تواند شکست بخورد ، که می تواند با code موجود در خطا مشخص شود.

* پیش بینی ناموفق: برنامه در حال حاضر در برگه مرورگر دیگر باز است. * غیرقابل اجرا: مرورگر با اجرای پایداری آفلاین ناسازگار است.

توجه داشته باشید که حتی پس از یک شکست ، نمونه Firestore قابل استفاده خواهد بود ، اما ماندگاری آفلاین غیرفعال خواهد شد.

پایداری را نمی توان در یک محیط node.js استفاده کرد.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که نشان دهنده موفقیت آمیز ذخیره مداوم است.

EnableMultitAbIndexedDbpersistion (Firestore)

این عملکرد در نسخه اصلی آینده حذف خواهد شد. در عوض ، FirestoreSettings.localCache به عنوان نمونه ای از PersistentLocalCache تنظیم کنید تا حافظه نهان IndexedDB را روشن کنید. فراخوانی این عملکرد هنگامی که FirestoreSettings.localCache از قبل مشخص شده است ، یک استثنا را به وجود می آورد.

در صورت امکان تلاش برای فعال کردن ذخیره مداوم چند تبی. در صورت فعال بودن در همه زبانه ها ، کلیه عملیات دسترسی به پایداری محلی ، از جمله اجرای مشترک نمایش داده ها و به روزرسانی های اسناد محلی با تأخیر در همه موارد متصل را به اشتراک می گذارد.

در صورت عدم موفقیت ، enableMultiTabIndexedDbPersistence() وعده را رد می کند یا یک استثنا را پرتاب می کند. دلایل مختلفی وجود دارد که این امر می تواند شکست بخورد ، که می تواند با code موجود در خطا مشخص شود.

* پیش بینی ناموفق: برنامه در حال حاضر در یک برگه مرورگر دیگر باز است و چند تبی فعال نیست. * غیرقابل اجرا: مرورگر با اجرای پایداری آفلاین ناسازگار است.

توجه داشته باشید که حتی پس از یک شکست ، نمونه Firestore قابل استفاده خواهد بود ، اما ماندگاری آفلاین غیرفعال خواهد شد.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که نشان دهنده موفقیت آمیز ذخیره مداوم است.

Enablenetwork (Firestore)

استفاده مجدد از شبکه را برای این نمونه Firestore پس از تماس قبلی به کارنامه های غیرفعال () .

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise ای که پس از فعال شدن شبکه حل می شود.

getpersistentcacheindexmanager (firestore)

مدیر شاخص PersistentCache را که توسط شیء Firestore داده شده استفاده می شود ، برمی گرداند.

در صورت عدم استفاده از ذخیره سازی محلی ، به عنوان مثال PersistentCacheIndexManager یا null .

امضا:

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

مولفه های

برمی‌گرداند:

PersonstentCacheIndexManager | خالی

LoadBundle (Firestore ، Bundledata)

بسته نرم افزاری Firestore را در حافظه نهان محلی بار می کند.

امضا:

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

مولفه های

برمی‌گرداند:

باربند

یک شیء LoadBundleTask ، که به تماس گیرنده ها با به روزرسانی های پیشرفت و رویدادهای تکمیل یا خطا اطلاع می دهد. می توان از آن به عنوان Promise<LoadBundleTaskProgress> استفاده کرد .

نامگذاری شده (Firestore ، نام)

یک پرس و جو Firestore را از حافظه نهان محلی می خواند ، که با نام مشخص شده مشخص شده است.

نمایش داده شدگان نامگذاری شده در بسته های سرور (همراه با اسناد حاصل) بسته بندی می شوند و با استفاده از loadBundle در حافظه نهان محلی بارگذاری می شوند . هنگامی که در حافظه نهان محلی قرار دارید ، از این روش برای استخراج پرس و جو با نام استفاده کنید.

امضا:

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

مولفه های

برمی‌گرداند:

وعده < پرس و جو | تهی>

Promise که با پرس و جو یا null حل می شود .

onsnapshotsinsync (Firestore ، Observer)

یک شنونده را برای یک رویداد Snapshots-in Sync ضمیمه می کند. رویداد Snapshots-in Sync نشان می دهد که همه شنوندگان تحت تأثیر یک تغییر معین اخراج شده اند ، حتی اگر یک تغییر ایجاد شده توسط سرور واحد بر شنوندگان متعدد تأثیر بگذارد.

توجه: رویداد Snapshots-in Sync فقط نشان می دهد که شنوندگان با یکدیگر همگام هستند ، اما مربوط به این نیست که آیا این عکسهای فوری با سرور همگام هستند. برای تعیین اینکه آیا عکس فوری از حافظه نهان یا سرور است ، از snapshotmetadata در شنوندگان جداگانه استفاده کنید.

امضا:

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

مولفه های

برمی‌گرداند:

لغو اشتراک

یک تابع لغو اشتراک که می تواند برای لغو شنونده عکس فوری فراخوانده شود.

onsnapshotsinsync (Firestore ، Onsync)

یک شنونده را برای یک رویداد Snapshots-in Sync ضمیمه می کند. رویداد Snapshots-in Sync نشان می دهد که همه شنوندگان تحت تأثیر یک تغییر معین اخراج شده اند ، حتی اگر یک تغییر ایجاد شده توسط سرور واحد بر شنوندگان متعدد تأثیر بگذارد.

توجه: رویداد Snapshots-in Sync فقط نشان می دهد که شنوندگان با یکدیگر همگام هستند ، اما مربوط به این نیست که آیا این عکسهای فوری با سرور همگام هستند. برای تعیین اینکه آیا عکس فوری از حافظه نهان یا سرور است ، از SnapshotMetadata در شنوندگان جداگانه استفاده کنید.

امضا:

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

مولفه های

برمی‌گرداند:

لغو اشتراک

یک تابع لغو اشتراک که می تواند برای لغو شنونده عکس فوری فراخوانده شود.

Runtransaction (Firestore ، UpdateFunction ، گزینه ها)

updateFunction داده شده را اجرا می کند و سپس تلاش می کند تا تغییرات اعمال شده در معامله را انجام دهد. اگر هر سندی که در معامله خوانده شده تغییر کرده باشد ، Cloud Firestore updateFunction را بازسازی می کند . اگر پس از 5 تلاش نتواند مرتکب شود ، معامله با شکست مواجه می شود.

حداکثر تعداد نوشتن مجاز در یک معامله واحد 500 است.

امضا:

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

مولفه های

برمی‌گرداند:

قول <t>

اگر معامله با موفقیت انجام شود یا صریحاً سقط شود (عملکرد updateFunction یک وعده ناموفق را برگرداند) ، وعده ای که توسط updateFunction برگردانده شد به اینجا برگردانده می شود در غیر این صورت ، در صورت عدم موفقیت معامله ، یک وعده رد شده با خطای خرابی مربوطه بازگردانده می شود.

SetIndexConfiguration (Firestore ، پیکربندی)

این API به عنوان پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است براساس بازخوردی که دریافت می کنیم تغییر کند. از این API در یک محیط تولید استفاده نکنید.

به جای ایجاد شاخص های حافظه نهان به صورت دستی ، با استفاده از enablePersistentCacheIndexAutoCreation() را در نظر بگیرید تا SDK تصمیم بگیرد که آیا برای نمایش داده های محلی در محلی ، شاخص های حافظه نهان ایجاد کند.

نمایه سازی را برای اجرای جستجوی محلی پیکربندی می کند. هر پیکربندی شاخص قبلی نادیده گرفته شده است. این Promise پس از ادامه پیکربندی شاخص حل می شود.

ورودی های این فهرست به صورت ناهمزمان ایجاد می شوند. حتی اگر هنوز شاخص ها در دسترس نباشند ، می توانید به استفاده از نمایش داده هایی که نیاز به نمایه سازی دارند ، ادامه دهید. اجرای Query پس از نوشتن فهرست ، به طور خودکار با استفاده از فهرست شروع می شود.

ایندکس ها فقط با ماندگاری IndexedDB پشتیبانی می شوند. اگر IndexedDB فعال نباشد ، هر پیکربندی شاخص نادیده گرفته می شود.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که پس از پیکربندی موفقیت آمیز همه شاخص ها برطرف می شود.

استثناها

FirestoreError اگر قالب JSON نامعتبر باشد.

SetIndexConfiguration (Firestore ، JSON)

این API به عنوان پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است براساس بازخوردی که دریافت می کنیم تغییر کند. از این API در یک محیط تولید استفاده نکنید.

به جای ایجاد شاخص های حافظه نهان به صورت دستی ، با استفاده از enablePersistentCacheIndexAutoCreation() را در نظر بگیرید تا SDK تصمیم بگیرد که آیا برای نمایش داده های محلی در محلی ، شاخص های حافظه نهان ایجاد کند.

نمایه سازی را برای اجرای جستجوی محلی پیکربندی می کند. هر پیکربندی شاخص قبلی نادیده گرفته شده است. این Promise پس از ادامه پیکربندی شاخص حل می شود.

ورودی های این فهرست به صورت ناهمزمان ایجاد می شوند. حتی اگر هنوز شاخص ها در دسترس نباشند ، می توانید به استفاده از نمایش داده هایی که نیاز به نمایه سازی دارند ، ادامه دهید. اجرای Query پس از نوشتن فهرست ، به طور خودکار با استفاده از فهرست شروع می شود.

ایندکس ها فقط با ماندگاری IndexedDB پشتیبانی می شوند. قبل از تنظیم پیکربندی شاخص ، از طریق enableIndexedDbPersistence() یا enableMultiTabIndexedDbPersistence() استفاده کنید. اگر IndexedDB فعال نباشد ، هر پیکربندی شاخص نادیده گرفته می شود.

این روش قالب JSON صادر شده توسط Firebase CLI را می پذیرد ( firebase firestore:indexes ). اگر قالب JSON نامعتبر باشد ، این روش خطایی را به وجود می آورد.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که پس از پیکربندی موفقیت آمیز همه شاخص ها برطرف می شود.

استثناها

FirestoreError اگر قالب JSON نامعتبر باشد.

خاتمه (آتش نشانی)

نمونه Firestore ارائه شده را خاتمه می دهد.

پس از فراخوانی terminate() فقط از عملکرد clearIndexedDbPersistence() استفاده می شود. هر عملکرد دیگری یک FirestoreError پرتاب می کند .

برای شروع مجدد پس از خاتمه ، نمونه جدیدی از Firebasefirestore با GetFirestore () ایجاد کنید .

خاتمه هیچ نوشتن در انتظار را لغو نمی کند ، و هرگونه وعده ای که در انتظار پاسخ سرور هستند برطرف نمی شوند. اگر پایداری را فعال کرده اید ، دفعه بعد که این نمونه را شروع می کنید ، ارسال این نویسندگان به سرور از سر می گیرد.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که با موفقیت در نمونه برطرف می شود.

WaitforpendingWrites (Firestore)

منتظر است تا همه در حال حاضر در انتظار نوشتن برای کاربر فعال توسط پس زمینه تأیید شده باشد.

در صورت عدم وجود نوشتن برجسته ، قول برگشتی بلافاصله حل می شود. در غیر این صورت ، این وعده منتظر است تا همه نوشته های قبلی صادر شده (از جمله مواردی که در یک جلسه برنامه قبلی نوشته شده است) ، اما منتظر نوشتن هایی نیست که پس از فراخوانی عملکرد اضافه شده اند. اگر می خواهید منتظر نوشتن های اضافی باشید ، دوباره با waitForPendingWrites() تماس بگیرید.

هر وعده برجسته waitForPendingWrites() در هنگام تغییرات کاربر رد می شود.

امضا:

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

مولفه های

برمی‌گرداند:

قول <void>

Promise که وقتی همه نوشته های در حال حاضر در حال انتظار هستند ، توسط پس زمینه تأیید شده است.

WritBatch (Firestore)

یک دسته نوشتن ایجاد می کند ، که برای انجام چندین نوشتن به عنوان یک عمل اتمی واحد استفاده می شود. حداکثر تعداد نوشتن مجاز در یک نوشتن واحد 500 است.

بر خلاف معاملات ، دسته های نوشتن به صورت آفلاین ادامه دارند و بنابراین وقتی نیازی به شرط نوشتن خود در داده های خوانده شده نیست ، ترجیح می دهند.

امضا:

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

مولفه های

برمی‌گرداند:

نوشتن

نوشتن نامه ای که می تواند برای اجرای اتمی چندین نوشتن استفاده شود.

تابع()

شمردن()

یک شیء AggregateField ایجاد کنید که می تواند برای محاسبه تعداد اسناد در مجموعه نتیجه یک پرس و جو استفاده شود.

امضا:

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

برمی‌گرداند:

در کل <تعداد>

Deletefield ()

یک Sentinel را برای استفاده با به روز شده () یا setDoc () با {merge: true} برای علامت گذاری یک فیلد برای حذف برمی گرداند.

امضا:

export declare function deleteField(): FieldValue;

برمی‌گرداند:

مقادیر میدانی

DocumentID ()

برای مراجعه به شناسه یک سند ، یک FieldPath ویژه Sentinel را برمی گرداند. می توان از آن در پرس و جو برای مرتب سازی یا فیلتر کردن توسط شناسه سند استفاده کرد.

امضا:

export declare function documentId(): FieldPath;

برمی‌گرداند:

مسیر

getFirestore ()

نمونه Firestore پیش فرض موجود را که با Firebaseapp پیش فرض همراه است ، برمی گرداند . اگر نمونه ای وجود نداشته باشد ، نمونه جدیدی را با تنظیمات پیش فرض آغاز می کند.

امضا:

export declare function getFirestore(): Firestore;

برمی‌گرداند:

آتش نشانی

نمونه پیش فرض Firestore از برنامه پیش فرض.

MemoryeagergargageCollector ()

نمونه ای از MemoryEagerGarbageCollector را ایجاد می کند . این همچنین جمع کننده زباله های پیش فرض است مگر اینکه صریحاً مشخص شود.

امضا:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

برمی‌گرداند:

Memoreeagergargagecollector

PersistentMultipletAbmanager ()

نمونه ای از PersistentMultipleTabManager را ایجاد می کند .

امضا:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

برمی‌گرداند:

PersistentMultipletAbmanager

servertimestamp ()

یک Sentinel که با SetDoc () یا به روز شده () استفاده می شود ، باز می گردد تا یک جدول زمانی تولید شده توسط سرور را در داده های نوشتاری درج کند.

امضا:

export declare function serverTimestamp(): FieldValue;

برمی‌گرداند:

مقادیر میدانی

تابع (DatabaseId ، ...)

GetFirestore (DatabaseId)

این API به عنوان پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است براساس بازخوردی که دریافت می کنیم تغییر کند. از این API در یک محیط تولید استفاده نکنید.

نمونه Firestore موجود موجود را که با Firebaseapp پیش فرض همراه است ، برمی گرداند . اگر نمونه ای وجود نداشته باشد ، نمونه جدیدی را با تنظیمات پیش فرض آغاز می کند.

امضا:

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

مولفه های

برمی‌گرداند:

آتش نشانی

نمونه Firestore نامگذاری شده از برنامه پیش فرض.

عملکرد (عناصر ، ...)

arrayremove (عناصر)

یک مقدار ویژه را که می تواند با SetDoc () استفاده شود ، برمی گرداند یا به سرور می گوید عناصر داده شده را از هر مقدار آرایه ای که قبلاً در سرور وجود دارد حذف کند. تمام نمونه های هر عنصر مشخص شده از آرایه حذف می شوند. اگر زمینه اصلاح شده در حال حاضر آرایه ای نباشد ، با یک آرایه خالی رونویسی می شود.

امضا:

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

مولفه های

برمی‌گرداند:

مقادیر میدانی

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

arrayUnion(elements)

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

امضا:

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

مولفه های

برمی‌گرداند:

FieldValue

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

function(field, ...)

average(field)

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

امضا:

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

مولفه های

برمی‌گرداند:

AggregateField <number | null>

sum(field)

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

امضا:

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

مولفه های

برمی‌گرداند:

AggregateField <تعداد>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

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

امضا:

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

مولفه های

برمی‌گرداند:

خالی

disablePersistentCacheIndexAutoCreation(indexManager)

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

امضا:

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

مولفه های

برمی‌گرداند:

خالی

enablePersistentCacheIndexAutoCreation(indexManager)

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

این قابلیت به طور پیشفرض غیر فعال است.

امضا:

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

مولفه های

برمی‌گرداند:

خالی

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

امضا:

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

مولفه های

برمی‌گرداند:

بولی

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

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

امضا:

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

مولفه های

برمی‌گرداند:

بولی

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

queryEqual(left, right)

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

امضا:

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

مولفه های

برمی‌گرداند:

بولی

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

refEqual(left, right)

Returns true if the provided references are equal.

امضا:

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

مولفه های

برمی‌گرداند:

بولی

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

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

امضا:

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

مولفه های

برمی‌گرداند:

بولی

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

امضا:

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

مولفه های

برمی‌گرداند:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

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

امضا:

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

مولفه های

برمی‌گرداند:

خالی

function(n, ...)

increment(n)

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

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

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

امضا:

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

مولفه های

برمی‌گرداند:

FieldValue

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

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

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

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

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

مثال

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

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

getCountFromServer(query)

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

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

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

امضا:

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

مولفه های

برمی‌گرداند:

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

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

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

امضا:

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

مولفه های

برمی‌گرداند:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

getDocsFromCache(query)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

getDocsFromServer(query)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

onSnapshot(query, observer)

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

onSnapshot(query, options, observer)

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

onSnapshot(query, onNext, onError, onCompletion)

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

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

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

query(query, compositeFilter, queryConstraints)

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

امضا:

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

مولفه های

برمی‌گرداند:

پرس و جو <AppModelType, DbModelType>

استثناها

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

query(query, queryConstraints)

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

امضا:

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

مولفه های

برمی‌گرداند:

پرس و جو <AppModelType, DbModelType>

استثناها

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

function(queryConstraints, ...)

and(queryConstraints)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise< DocumentReference <AppModelType, DbModelType>>

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

collection(reference, path, pathSegments)

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

امضا:

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

مولفه های

برمی‌گرداند:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

استثناها

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

collection(reference, path, pathSegments)

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

امضا:

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

مولفه های

برمی‌گرداند:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

استثناها

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

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

امضا:

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

مولفه های

برمی‌گرداند:

Promise<void>

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

doc(reference, path, pathSegments)

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

امضا:

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

مولفه های

برمی‌گرداند:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

استثناها

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

doc(reference, path, pathSegments)

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

امضا:

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

مولفه های

برمی‌گرداند:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

استثناها

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

getDoc(reference)

Reads the document referred to by this DocumentReference .

امضا:

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

مولفه های

برمی‌گرداند:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

getDocFromCache(reference)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

getDocFromServer(reference)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

onSnapshot(reference, observer)

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

onSnapshot(reference, options, observer)

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

onSnapshot(reference, onNext, onError, onCompletion)

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

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

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

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

امضا:

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;

مولفه های

برمی‌گرداند:

لغو اشتراک

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

setDoc(reference, data)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise<void>

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

setDoc(reference, data, options)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise<void>

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

updateDoc(reference, data)

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise<void>

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

updateDoc(reference, field, value, moreFieldsAndValues)

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

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

امضا:

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

مولفه های

برمی‌گرداند:

Promise<void>

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

function(settings, ...)

memoryLocalCache(settings)

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

امضا:

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

مولفه های

برمی‌گرداند:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

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

امضا:

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

مولفه های

برمی‌گرداند:

MemoryLruGarbageCollector

persistentLocalCache(settings)

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

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

امضا:

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

مولفه های

برمی‌گرداند:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

امضا:

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

مولفه های

برمی‌گرداند:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

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

امضا:

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

مولفه های

برمی‌گرداند:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

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

امضا:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

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

امضا:

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

AggregateFieldType

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

امضا:

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

AggregateSpecData

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

امضا:

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

AggregateType

Union type representing the aggregate type to be performed.

امضا:

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

ChildUpdateFields

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

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

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

امضا:

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

DocumentChangeType

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

امضا:

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

FirestoreErrorCode

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

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

امضا:

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

FirestoreLocalCache

Union type from all supported SDK cache layer.

امضا:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

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

امضا:

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

MemoryGarbageCollector

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

امضا:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

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

امضا:

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

OrderByDirection

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

امضا:

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

PartialWithFieldValue

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

امضا:

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

PersistentTabManager

A union of all available tab managers.

امضا:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

اولیه

Primitive types.

امضا:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

امضا:

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

QueryFilterConstraint

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

امضا:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

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

امضا:

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

SetOptions

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

امضا:

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

TaskState

Represents the state of bundle loading tasks.

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

امضا:

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

UnionToIntersection

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

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

امضا:

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

بروزرسانی اطلاعات

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

امضا:

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

WhereFilterOp

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

امضا:

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

WithFieldValue

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

امضا:

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