@firebase/firestore/lite

کارکرد

کلاس ها

رابط ها

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

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

getFirestore (برنامه)

نمونه Firestore پیش‌فرض موجود را که با FirebaseApp ارائه شده مرتبط است، برمی‌گرداند . اگر هیچ نمونه ای وجود نداشته باشد، یک نمونه جدید با تنظیمات پیش فرض مقداردهی اولیه می کند.

امضا:

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

مولفه های

برمی گرداند:

آتش نشانی

نمونه Firestore برنامه ارائه شده.

getFirestore (برنامه، شناسه پایگاه داده)

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

نمونه Firestore موجود را که با FirebaseApp ارائه شده مرتبط است، برمی‌گرداند . اگر هیچ نمونه ای وجود نداشته باشد، یک نمونه جدید با تنظیمات پیش فرض مقداردهی اولیه می کند.

امضا:

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

مولفه های

برمی گرداند:

آتش نشانی

نمونه Firestore برنامه ارائه شده.

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

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

امضا:

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

مولفه های

برمی گرداند:

آتش نشانی

یک نمونه Firestore که به تازگی راه اندازی شده است.

InitializeFirestore (برنامه، تنظیمات، شناسه پایگاه داده)

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

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

امضا:

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

مولفه های

برمی گرداند:

آتش نشانی

یک نمونه Firestore که به تازگی راه اندازی شده است.

عملکرد (Firestore، ...)

مجموعه (Firestore، مسیر، 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;

مولفه های

برمی گرداند:

خالی

DOC (Firestore ، Path ، Pathsegments)

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

امضا:

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

مولفه های

برمی گرداند:

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

نمونه DocumentReference .

استثناها

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

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 برگردانده شد به اینجا برگردانده می شود در غیر این صورت ، در صورت عدم موفقیت معامله ، یک وعده رد شده با خطای خرابی مربوطه بازگردانده می شود.

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

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

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

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

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

WritBatch (Firestore)

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

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

امضا:

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

مولفه های

برمی گرداند:

نوشتن

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

تابع()

شمردن()

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

امضا:

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

برمی گرداند:

در کل <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 از برنامه ارائه شده.

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;

مولفه های

برمی گرداند:

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

Sentinel FieldValue برای استفاده در تماس با setDoc() یا updateDoc()

ArrayUnion (عناصر)

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

امضا:

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

مولفه های

برمی گرداند:

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

Sentinel FieldValue برای استفاده در تماس با setDoc() یا updateDoc() .

عملکرد (فیلد ، ...)

میانگین (زمینه)

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

امضا:

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

مولفه های

برمی گرداند:

در کل <شماره | null>

جمع (زمینه)

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

امضا:

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

مولفه های

برمی گرداند:

در کل <Number>

تابع (pathpath ، ...)

Orderby (FieldPath ، DirectionStr)

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

امضا:

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

مولفه های

برمی گرداند:

queryorderbyconstraint

queryorderbyconstaint ایجاد شده است .

WHERE (FieldPath ، OPSTR ، مقدار)

queryfieldfilterconstraint را ایجاد می کند که اجرای اسناد باید شامل قسمت مشخص شده باشد و این مقدار باید محدودیت رابطه ارائه شده را برآورده کند.

امضا:

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

مولفه های

برمی گرداند:

queryfieldfilterconstraint

queryfieldfilterconstraint ایجاد شده است .

عملکرد (FieldValues ​​، ...)

Endat (FieldValues)

queryendatconstraint را ایجاد می کند که نتیجه تعیین شده را برای پایان دادن به زمینه های ارائه شده نسبت به ترتیب پرس و جو تغییر می دهد. ترتیب مقادیر میدانی باید با ترتیب سفارش توسط بندهای پرس و جو مطابقت داشته باشد.

امضا:

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

مولفه های

برمی گرداند:

queryendatconstraint

یک Queryendatconstraint برای عبور به query()

endbefore (fieldvalues)

queryendatconstraint را ایجاد می کند که نتیجه تعیین شده برای پایان دادن به قسمتهای ارائه شده نسبت به ترتیب پرس و جو را تغییر می دهد. ترتیب مقادیر میدانی باید با ترتیب سفارش توسط بندهای پرس و جو مطابقت داشته باشد.

امضا:

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

مولفه های

برمی گرداند:

queryendatconstraint

یک Queryendatconstraint برای عبور به query()

Startafter (FieldValues)

querystartatconstraint را ایجاد می کند که نتیجه تعیین شده را برای شروع بعد از زمینه های ارائه شده نسبت به ترتیب پرس و جو تغییر می دهد. ترتیب مقادیر میدانی باید با ترتیب سفارش توسط بندهای پرس و جو مطابقت داشته باشد.

امضا:

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

مولفه های

برمی گرداند:

پرس و جو

یک Querystartatconstraint برای عبور به query()

Startat (FieldValues)

querystartatconstraint را ایجاد می کند که نتیجه تعیین شده را برای شروع در زمینه های ارائه شده نسبت به ترتیب پرس و جو تغییر می دهد. ترتیب مقادیر میدانی باید با ترتیب سفارش توسط بندهای پرس و جو مطابقت داشته باشد.

امضا:

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

مولفه های

برمی گرداند:

پرس و جو

یک Querystartatconstraint برای عبور به query() .

عملکرد (سمت چپ ، ...)

Eggregatefieldequal (چپ ، راست)

دو 'جمع شده را با هم مقایسه می کند `مواردی برای برابری.

امضا:

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

مولفه های

برمی گرداند:

بولی

ExgregateQuerysnapshotequal (چپ ، راست)

دو نمونه AggregateQuerySnapshot برای برابری را با هم مقایسه می کند.

دو نمونه AggregateQuerySnapshot در صورتی که دارای پرس و جوهای اساسی باشند که با هم مقایسه می شوند و داده های یکسانی دارند ، "برابر" تلقی می شوند.

امضا:

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

مولفه های

برمی گرداند:

بولی

true اگر اشیاء "برابر" باشند ، همانطور که در بالا تعریف شده است ، یا در غیر این صورت false .

queryequal (چپ ، راست)

اگر سؤالات ارائه شده به همان مجموعه اشاره کنند و همان محدودیت ها را اعمال کنند ، درست باز می گردد.

امضا:

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

مولفه های

برمی گرداند:

بولی

درست است اگر منابع در همان پایگاه داده Firestore به همان مکان اشاره کنند.

Refequal (چپ ، راست)

اگر منابع ارائه شده برابر باشند ، درست باز می گردد.

امضا:

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

مولفه های

برمی گرداند:

بولی

درست است اگر منابع در همان پایگاه داده Firestore به همان مکان اشاره کنند.

snapshotequal (چپ ، راست)

اگر عکسهای فوری ارائه شده برابر باشند ، درست باز می گردد.

امضا:

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

مولفه های

برمی گرداند:

بولی

اگر عکسهای فوری برابر باشند ، درست است.

عملکرد (حد ، ...)

حد (حد)

querylimitconstraint را ایجاد می کند که فقط اولین اسناد تطبیق را برمی گرداند.

امضا:

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

مولفه های

برمی گرداند:

querylimitconstraint

querylimitconstraint ایجاد شده .

limitToLast(Limit)

querylimitconstraint را ایجاد می کند که فقط آخرین اسناد مطابق را برمی گرداند.

شما باید حداقل یک بند orderBy را برای نمایش داده های limitToLast مشخص کنید ، در غیر این صورت یک استثنا در حین اجرا پرتاب می شود.

امضا:

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

مولفه های

برمی گرداند:

querylimitconstraint

querylimitconstraint ایجاد شده .

عملکرد (ورود به سیستم ، ...)

setLoglevel (loglevel)

کمبود سیاهههای مربوط به Firestore Cloud (اشکال زدایی ، خطا یا ساکت) را تنظیم می کند.

امضا:

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

مولفه های

برمی گرداند:

خالی

عملکرد (n ، ...)

افزایش (N)

مقدار ویژه ای را که می تواند با SetDoc () یا به روز شده () که به سرور می گوید مقدار فعلی این فیلد را با مقدار داده شده افزایش می دهد ، برمی گرداند.

اگر Operand یا مقدار میدان فعلی از دقت نقطه شناور استفاده کند ، تمام حسابی از معانی IEEE 754 پیروی می کنند. اگر هر دو مقدار عدد صحیح باشند ، مقادیر خارج از محدوده شماره ایمن جاوا اسکریپت ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) همچنین در معرض ضرر دقیق قرار دارند. علاوه بر این ، پس از پردازش توسط پس زمینه Firestore ، تمام عملیات عدد صحیح بین -2^63 و 2^63-1 پوشانده می شوند.

اگر مقدار فیلد فعلی از number نوع نباشد ، یا اگر این زمینه هنوز وجود نداشته باشد ، تحول قسمت را به مقدار داده شده تنظیم می کند.

امضا:

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

مولفه های

برمی گرداند:

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

Sentinel FieldValue برای استفاده در تماس با setDoc() یا updateDoc()

تابع (پرس و جو، ...)

getAggregate (پرس و جو، aggregateSpec)

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

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

امضا:

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

مولفه های

برمی گرداند:

وعده < جمع شده <GegregatesPectype ، AppModeltype ، dbmodeltype >>

مثال

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 (پرس و جو)

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

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

امضا:

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

مولفه های

برمی گرداند:

وعده < جمع شده <{COUNT: AggregateField <Number> ؛ } ، AppModeltype ، dbmodeltype >>

قولی که با شمارش حل می شود. شمارش را می توان از snapshot.data().count ، جایی که snapshot AggregateQuerySnapshot است که قول برگشتی برطرف می شود.

getDocs (پرس و جو)

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

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

امضا:

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

مولفه های

برمی گرداند:

قول < querysnapshot <AppModeltype ، dbmodeltype >>

قولی که با نتایج پرس و جو برطرف می شود.

پرس و جو (پرس و جو ، CompositeFilter ، QueryConstints)

یک نمونه تغییر ناپذیر جدید از پرس و جو ایجاد می کند که گسترش می یابد و شامل محدودیت های پرس و جو اضافی نیز می شود.

امضا:

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

مولفه های

برمی گرداند:

پرس و جو <AppModeltype ، dbmodeltype>

استثناها

اگر هیچ یک از محدودیت های پرس و جو ارائه شده با محدودیت های موجود یا جدید قابل ترکیب نباشد.

پرس و جو (پرس و جو ، queryconstints)

یک نمونه تغییر ناپذیر جدید از پرس و جو ایجاد می کند که گسترش می یابد و شامل محدودیت های پرس و جو اضافی نیز می شود.

امضا:

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

مولفه های

برمی گرداند:

پرس و جو <AppModeltype ، dbmodeltype>

استثناها

اگر هیچ یک از محدودیت های پرس و جو ارائه شده با محدودیت های موجود یا جدید قابل ترکیب نباشد.

عملکرد (queryConstints ، ...)

و (queryconstraints)

یک queryCompositeFilterConstraint جدید ایجاد می کند که پیوستگی محدودیت های فیلتر داده شده است. اگر تمام فیلترهای داده شده را برآورده کند ، یک فیلتر پیوندی شامل یک سند است.

امضا:

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

مولفه های

برمی گرداند:

queryCompositeFilterConstraint

QueryCompositeFilterConstraint تازه ایجاد شده .

یا (queryconstraints)

یک queryCompositeFilterConstraint جدید ایجاد می کند که اختلال در محدودیت های فیلتر داده شده است. اگر هر یک از فیلترهای داده شده را برآورده کند ، یک فیلتر اختلال شامل یک سند است.

امضا:

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

مولفه های

برمی گرداند:

queryCompositeFilterConstraint

QueryCompositeFilterConstraint تازه ایجاد شده .

تابع (مرجع ، ...)

addDoc (مرجع ، داده ها)

یک سند جدید را به CollectionReference داده های مشخص شده با داده های داده شده اضافه کنید و به طور خودکار شناسه سند را به آن اختصاص دهید.

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

امضا:

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

مولفه های

برمی گرداند:

وعده < DocumentReference <AppModeltype ، dbmodeltype >>

Promise ای که با یک DocumentReference به سند تازه ایجاد شده پس از نوشته شده در پس زمینه ، حل شد.

استثناها

خطا - اگر ورودی ارائه شده یک سند Firestore معتبر نباشد.

مجموعه (مرجع ، مسیر ، مسیر)

یک نمونه CollectionReference است که به یک زیر مجموعه reference در مسیر نسبی مشخص شده اشاره دارد.

امضا:

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

مولفه های

برمی گرداند:

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

نمونه CollectionReference .

استثناها

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

مجموعه (مرجع ، مسیر ، مسیر)

یک نمونه CollectionReference است که به یک زیر مجموعه reference در مسیر نسبی مشخص شده اشاره دارد.

امضا:

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

مولفه های

برمی گرداند:

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

نمونه CollectionReference .

استثناها

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

حذف (مرجع)

سندی را که توسط DocumentReference مشخص شده به آن اشاره شده است حذف می کند .

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

هنگامی که این سند با موفقیت از پس زمینه حذف شد ، Promise حل شد.

DOC (مرجع ، مسیر ، مسیر)

یک نمونه DocumentReference می شود که به یک سندی در reference در مسیر نسبی مشخص شده اشاره دارد. اگر هیچ مسیری مشخص نشده باشد ، از یک شناسه منحصر به فرد تولید شده به طور خودکار برای بازپرداخت DocumentReference استفاده می شود .

امضا:

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

مولفه های

برمی گرداند:

مرجع مستندات <AppModeltype ، dbmodeltype>

نمونه DocumentReference .

استثناها

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

DOC (مرجع ، مسیر ، مسیر)

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

امضا:

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

مولفه های

برمی گرداند:

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

نمونه DocumentReference .

استثناها

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

getDoc (مرجع)

سندی را که توسط مرجع اسناد مشخص شده به آن اشاره شده است ، می خواند.

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

امضا:

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

مولفه های

برمی گرداند:

قول < DocumentSnapShot <AppModeltype ، dbmodeltype >>

وعده ای که با یک DocumentSnapshot حاوی محتویات سند فعلی حل شد.

setDoc (مرجع ، داده ها)

به سندی که توسط DocumentReference مشخص شده است می نویسد . اگر این سند هنوز وجود نداشته باشد ، ایجاد می شود.

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

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

استثناها

خطا - اگر ورودی ارائه شده یک سند Firestore معتبر نباشد.

setDoc (مرجع ، داده ها ، گزینه ها)

به سندی که توسط DocumentReference مشخص شده است می نویسد . اگر این سند هنوز وجود نداشته باشد ، ایجاد می شود. اگر مزارع merge یا mergeFields ارائه می دهید ، داده های ارائه شده را می توان در یک سند موجود ادغام کرد.

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

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

استثناها

خطا - اگر ورودی ارائه شده یک سند Firestore معتبر نباشد.

به روز شده (مرجع ، داده ها)

زمینه های به روزرسانی در سند ذکر شده توسط DocumentReference مشخص شده . در صورت اعمال سندی که وجود ندارد ، این بروزرسانی شکست خواهد خورد.

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

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

استثناها

خطا - اگر ورودی ارائه شده داده های Firestore معتبر نباشد.

به روز شده (مرجع ، فیلد ، مقدار ، morefieldsandlates)

زمینه های به روزرسانی در سند ذکر شده توسط DocumentReference مشخص شده در صورت استفاده از سندی که وجود ندارد ، به روزرسانی می شود.

زمینه های تو در تو با ارائه رشته های مسیر جداگانه جدا شده یا با ارائه اشیاء FieldPath می توانند به روز شوند.

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

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

استثناها

خطا - اگر ورودی ارائه شده داده های Firestore معتبر نباشد.

عملکرد (عکس فوری ، ...)

Endat (عکس فوری)

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

امضا:

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

مولفه های

برمی گرداند:

queryendatconstraint

یک Queryendatconstraint برای عبور به query()

endbefore (عکس فوری)

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

امضا:

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

مولفه های

برمی گرداند:

queryendatconstraint

یک Queryendatconstraint برای عبور به query()

Startafter (عکس فوری)

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

امضا:

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

مولفه های

برمی گرداند:

پرس و جو

یک Querystartatconstraint برای عبور به query()

Startat (عکس فوری)

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

امضا:

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

مولفه های

برمی گرداند:

پرس و جو

یک Querystartatconstraint برای عبور به query() .

addPrefixtokeys

نقشه جدیدی را برمی گرداند که در آن هر کلید با کلید بیرونی که به یک نقطه اضافه شده است ، پیشوند می شود.

امضا:

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];
};

هم جمع سازی

اتحادیه همه انواع AggregateField شده توسط Firestore.

امضا:

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

کلبه های

نوعی که کلیدهای آن از یک AggregateSpec گرفته شده است ، و مقادیر آنها نتیجه تجمع انجام شده توسط AggregateField مربوطه از AggregateSpec ورودی است .

امضا:

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

از نوع تجمع

نوع اتحادیه به نمایندگی از نوع کل که باید انجام شود.

امضا:

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

بچه های کودک

یاور برای محاسبه زمینه های تو در تو برای نوع T1 معین. این مورد برای توزیع انواع اتحادیه مانند undefined | {...} (برای غرفه های اختیاری اتفاق می افتد) یا {a: A} | {b: B} .

در این مورد استفاده ، V برای توزیع انواع اتحادیه T[K] در Record استفاده می شود ، از آنجا که T[K] به عنوان یک عبارت ارزیابی می شود و توزیع نمی شود.

به https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditivity-types مراجعه کنید

امضا:

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

کد

مجموعه کدهای وضعیت Firestore. کدها در مواردی که توسط GRPC در اینجا قرار دارند یکسان هستند: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

مقادیر ممکن: - "لغو": این عملیات لغو شد (به طور معمول توسط تماس گیرنده). - "ناشناخته": خطای ناشناخته یا خطایی از دامنه خطای متفاوت. - 'نامعتبر-بحث': مشتری یک استدلال نامعتبر را مشخص کرد. توجه داشته باشید که این با "پیش بینی شکست خورده" متفاوت است. "Argument نامعتبر" استدلال هایی را نشان می دهد که بدون توجه به وضعیت سیستم مشکل ساز هستند (به عنوان مثال یک نام فیلد نامعتبر). - "مهلت-از او بیش از": مهلت قبل از اتمام عمل می تواند تمام شود. برای عملیاتی که وضعیت سیستم را تغییر می دهد ، ممکن است این خطا حتی اگر این عملیات با موفقیت انجام شود ، برگردانده شود. به عنوان مثال ، یک پاسخ موفق از سرور می توانست به اندازه کافی طولانی به تأخیر بیفتد تا مهلت منقضی شود. - "نه found": برخی از اسناد درخواست شده یافت نشد. - "در حال حاضر موجود": برخی از سندی که ما سعی در ایجاد آن داشتیم از قبل وجود دارد. - "مجوز": تماس گیرنده اجازه اجرای عملیات مشخص را ندارد. -"منابع-اکسپرس": برخی از منابع خسته شده اند ، شاید سهمیه برای هر کاربر یا شاید کل سیستم پرونده از فضا خارج باشد. - "پیشینه شکست": عملیات رد شد زیرا سیستم در وضعیت لازم برای اجرای عملیات نیست. - "سقط جنین": این عملیات سقط شده است ، به طور معمول به دلیل یک مسئله همزمانی مانند سقط های معامله و غیره- "خارج از محدوده": عملیات از محدوده معتبر استفاده می شد. - "عدم اجرای": عملیات اجرا نمی شود یا پشتیبانی نمی شود/فعال نمی شود. - "داخلی": خطاهای داخلی. به معنای برخی از متغیرهای مورد انتظار توسط سیستم اساسی شکسته شده است. اگر یکی از این خطاها را می بینید ، چیزی بسیار شکسته است. - "در دسترس نیست": این سرویس در حال حاضر در دسترس نیست. این به احتمال زیاد یک بیماری گذرا است و ممکن است با استفاده مجدد از پس از آن اصلاح شود. - "داده-از دست دادن": از دست دادن داده های غیرقابل برگشت یا فساد. - "غیرمجاز": درخواست اعتبار تأیید اعتبار معتبر برای این عملیات ندارد.

امضا:

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

میدان های تو در تو

برای هر زمینه (به عنوان مثال "نوار") ، تمام کلیدهای تو در تو را پیدا کنید (به عنوان مثال { 'bar.baz': t1 ، 'bar.qux': t2 } ). آنها را در کنار هم قرار دهید تا یک نقشه واحد حاوی تمام کلیدهای ممکن باشد که همه به عنوان اختیاری مشخص شده اند

امضا:

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

جهت دار

جهت یک بند Orderby () به عنوان "نزولی" یا "ASC" (نزولی یا صعودی) مشخص شده است.

امضا:

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

SPALWITHFIELDVALUE

مشابه Partial<T> Typecript ، اما اجازه می دهد تا زمینه های تو در تو حذف شوند و مقادیر میدانی به عنوان مقادیر خاصیت منتقل شوند.

امضا:

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

اولیه

انواع ابتدایی.

امضا:

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

queryconstrainttype

محدودیت های مختلف پرس و جو موجود در این SDK را توصیف می کند.

امضا:

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

queryfilterconstraint

QueryFilterConstraint یک نوع اتحادیه یاور است که نمایانگر queryfieldfilterconstraint و querycompositefilterconstraint است .

امضا:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

querynonfilterconstraint

QueryNonFilterConstraint یک نوع اتحادیه یاور است که نمایانگر queryConstints است که برای باریک شدن یا سفارش مجموعه اسناد استفاده می شود ، اما به صراحت در یک زمینه سند فیلتر نمی شوند. QueryNonFilterConstraint S با استناد به Orderby () ایجاد می شوند ، شروع کن در() ، startafter () ، endbefore () ، endat () ، محدود () یا limittolast () و سپس می توانید به پرس و جو () منتقل شوید تا یک نمونه پرس و جو جدید ایجاد شود که شامل QueryConstraint نیز باشد .

امضا:

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

پیش بینی

یک شی گزینه ای که رفتار SetDoc را پیکربندی می کند () ، و تماس ها این تماسها می توانند برای انجام ادغام گرانول به جای بازنویسی اسناد هدف در کل خود با ارائه SetOptions با merge: true تنظیم شوند. .

امضا:

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

اتهامات اتحادیه

با توجه به یک نوع اتحادیه U = T1 | T2 | ... ، یک نوع تقاطع شده را برمی گرداند (T1 & T2 & ...) .

از انواع مشروط توزیع و استنباط از انواع مشروط استفاده می کند. این امر به این دلیل است که چندین نامزد برای متغیر یکسان در موقعیت های ضد متغیر باعث می شود که یک نوع تقاطع استنباط شود. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditionation-types https://stackoverflow.com/questions/50374908/transform-union-nion-type-to-m--in-in-intrationesection نوع

امضا:

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

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

به روزرسانی داده ها (برای استفاده با به روز شده () ) که شامل مسیرهای میدانی (به عنوان مثال "foo" یا "foo.baz") است که به مقادیر نقشه برداری شده است. زمینه هایی که حاوی قسمتهای مرجع نقاط در داخل سند هستند. مقادیر میدانی را می توان به عنوان مقادیر خاصیت منتقل کرد.

امضا:

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