database package

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

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

ConnectDatabaseEmulator (DB ، میزبان ، پورت ، گزینه ها)

برای برقراری ارتباط با شبیه ساز پایگاه داده Realtime ، نمونه ارائه شده را اصلاح کنید.

توجه: این روش باید قبل از انجام هرگونه عملیات دیگر فراخوانی شود.

امضا:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

مولفه های

پارامتر	تایپ کنید	شرح
دسی بی	پایگاه داده	نمونه برای اصلاح.
میزبان	رشته	میزبان شبیه ساز (سابق: localhost)
بندر	عدد	پورت شبیه ساز (سابق: 8080)
گزینه ها	{mockusertoken ؟: emulatormocktokenoptions \| رشته؛ }

برمی گرداند:

خالی

GOOFFLINE (DB)

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

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

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

برای اتصال مجدد به پایگاه داده و شروع به دریافت رویدادهای از راه دور ، به goOnline() .

امضا:

export declare function goOffline(db: Database): void;

مولفه های

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

برمی گرداند:

خالی

Goonline (DB)

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

این روش باید پس از غیرفعال کردن اتصال فعال با goOffline() استفاده شود . پس از اتصال مجدد ، مشتری داده های مناسب را منتقل می کند و رویدادهای مناسب را آتش می زند تا مشتری شما به طور خودکار "صعود کند".

امضا:

export declare function goOnline(db: Database): void;

مولفه های

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

برمی گرداند:

خالی

Ref (DB ، مسیر)

Reference را نشان می دهد که مکان را در پایگاه داده متناسب با مسیر ارائه شده نشان می دهد. در صورت عدم ارائه مسیری ، Reference به ریشه پایگاه داده اشاره خواهد کرد.

امضا:

export declare function ref(db: Database, path?: string): DatabaseReference;

مولفه های

پارامتر	تایپ کنید	شرح
دسی بی	پایگاه داده	نمونه بانک اطلاعاتی برای به دست آوردن مرجع برای.
مسیر	رشته	مسیر اختیاری نمایانگر مکانی است که `Reference` برگشتی به آن اشاره خواهد کرد. در صورت عدم ارائه ، `Reference` برگشتی به ریشه پایگاه داده اشاره خواهد کرد.

برمی گرداند:

در صورت ارائه مسیری ، Reference اشاره به مسیر ارائه شده. در غیر این صورت ، Reference اشاره به ریشه بانک اطلاعاتی.

reffromurl (db ، url)

یک Reference نشان می دهد که مکان در پایگاه داده مربوط به URL Firebase ارائه شده را نشان می دهد.

اگر URL یک URL معتبر پایگاه داده Firebase نباشد یا دامنه متفاوتی نسبت به نمونه Database فعلی داشته باشد ، یک استثناء پرتاب می شود.

توجه داشته باشید که تمام پارامترهای پرس و جو ( orderBy ، limitToLast ، و غیره) نادیده گرفته می شوند و در Reference برگشتی اعمال نمی شوند .

امضا:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

مولفه های

پارامتر	تایپ کنید	شرح
دسی بی	پایگاه داده	نمونه بانک اطلاعاتی برای به دست آوردن مرجع برای.
آدرس اینترنتی	رشته	URL Firebase که در آن `Reference` برگشتی به آن اشاره خواهد کرد.

برمی گرداند:

Reference اشاره به URL Firebase ارائه شده.

تابع()

forcelongpolling ()

به جای وب سایت ، استفاده از Polling را مجبور کنید. اگر از پروتکل WebSocket در DatabaseUrl استفاده شود ، این امر نادیده گرفته می شود.

امضا:

export declare function forceLongPolling(): void;

برمی گرداند:

خالی

forcewebsockets ()

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

امضا:

export declare function forceWebSockets(): void;

برمی گرداند:

خالی

OrderByKey ()

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

نتایج یک پرس و جو را بر اساس مقادیر کلیدی (صعودی) آنها مرتب می کند.

می توانید اطلاعات بیشتر در مورد orderByKey() را در داده های مرتب سازی بخوانید .

امضا:

export declare function orderByKey(): QueryConstraint;

برمی گرداند:

OrderByPriority ()

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

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

امضا:

export declare function orderByPriority(): QueryConstraint;

برمی گرداند:

OrderByValue ()

QueryConstraint جدید را ایجاد می کند که با ارزش سفارش می دهد.

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

می توانید اطلاعات بیشتری در مورد orderByValue() در داده های مرتب سازی بخوانید .

امضا:

export declare function orderByValue(): QueryConstraint;

برمی گرداند:

servertimestamp ()

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

امضا:

export declare function serverTimestamp(): object;

برمی گرداند:

هدف - شی

عملکرد (دلتا ، ...)

افزایش (دلتا)

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

امضا:

export declare function increment(delta: number): object;

مولفه های

پارامتر	تایپ کنید	شرح
دلتا	عدد	مبلغ برای تغییر مقدار فعلی به صورت اتمی.

برمی گرداند:

هدف - شی

یک مقدار نگهدارنده مکان برای اصلاح داده ها به صورت سرور آتمی.

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

enableLogging (فعال، مداوم)

اطلاعات مربوط به اشکال زدایی را به کنسول وارد کنید.

امضا:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

مولفه های

پارامتر	تایپ کنید	شرح
فعال شد	بولی	ورود به سیستم اگر `true` `false` ورود به سیستم را غیرفعال می کند.
مداوم	بولی	در صورت `true` ، وضعیت ورود به سیستم را بین تازه کردن صفحه به یاد می آورد.

برمی گرداند:

هر

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

limittofirst (حد)

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

از روش limitToFirst() برای تعیین حداکثر تعداد کودکانی که برای پاسخ به تماس مشخص شده همگام سازی می شوند ، استفاده می شود. اگر حد 100 را تعیین کنیم ، در ابتدا فقط 100 رویداد child_added دریافت خواهیم کرد. اگر کمتر از 100 پیام ذخیره شده در پایگاه داده خود داشته باشیم ، یک رویداد child_added برای هر پیام آتش می گیرد. با این حال ، اگر بیش از 100 پیام داشته باشیم ، فقط برای 100 پیام سفارش داده شده فقط یک رویداد child_added دریافت خواهیم کرد. با تغییر موارد ، ما برای هر موردی که از لیست فعال خارج می شود ، رویدادهای child_removed را دریافت خواهیم کرد تا تعداد کل در 100 باقی بماند.

می توانید اطلاعات بیشتر در مورد limitToFirst() را در فیلتر کردن داده ها بخوانید .

امضا:

export declare function limitToFirst(limit: number): QueryConstraint;

مولفه های

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

برمی گرداند:

Limittolast (حد)

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

از روش limitToLast() برای تعیین حداکثر تعداد کودکان برای همگام سازی برای پاسخ به تماس مشخص استفاده می شود. اگر حد 100 را تعیین کنیم ، در ابتدا فقط 100 رویداد child_added دریافت خواهیم کرد. اگر کمتر از 100 پیام ذخیره شده در پایگاه داده خود داشته باشیم ، یک رویداد child_added برای هر پیام آتش می گیرد. با این حال ، اگر بیش از 100 پیام داشته باشیم ، فقط برای 100 پیام سفارش داده شده فقط یک رویداد child_added دریافت خواهیم کرد. با تغییر موارد ، ما برای هر موردی که از لیست فعال خارج می شود ، رویدادهای child_removed را دریافت خواهیم کرد تا تعداد کل در 100 باقی بماند.

می توانید اطلاعات بیشتر در مورد limitToLast() را در فیلتر کردن داده ها بخوانید .

امضا:

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

مولفه های

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

برمی گرداند:

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

EnableLogging (logger)

اطلاعات مربوط به اشکال زدایی را به کنسول وارد کنید.

امضا:

export declare function enableLogging(logger: (message: string) => unknown): any;

مولفه های

پارامتر	تایپ کنید	شرح
متمرکز ساز	(پیام: رشته) => ناشناخته	یک تابع logger سفارشی برای کنترل نحوه ورود به سیستم.

برمی گرداند:

هر

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

فرزند (والدین ، مسیر)

برای مکان در مسیر نسبی مشخص Reference می شود.

مسیر نسبی می تواند یک نام کودک ساده (به عنوان مثال ، "ADA") یا یک مسیر جدا شده عمیق تر (به عنوان مثال ، "ADA/Name/First") باشد.

امضا:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

مولفه های

پارامتر	تایپ کنید	شرح
والدین	پایگاه داده	محل والدین
مسیر	رشته	یک مسیر نسبی از این مکان به محل مورد نظر کودک.

برمی گرداند:

مکان مشخص شده کودک

فشار (والدین ، ارزش)

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

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

اگر مقدار push() ، مقدار به مکان تولید شده نوشته شده است. اگر ارزشی را منتقل نکنید ، هیچ چیز به پایگاه داده نوشته نمی شود و کودک خالی باقی می ماند (اما می توانید از Reference در جای دیگر استفاده کنید).

کلیدهای منحصر به فرد تولید شده توسط push() توسط زمان فعلی سفارش داده می شوند ، بنابراین لیست حاصل از موارد از نظر زمانی مرتب شده است. کلیدها همچنین به گونه ای طراحی شده اند که غیرقابل توصیف باشند (آنها حاوی 72 بیت تصادفی آنتروپی هستند).

به لیستی از داده ها مراجعه کنید . 2^120 راه را برای اطمینان از شناسه های منحصر به فرد مشاهده کنید .

امضا:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

مولفه های

پارامتر	تایپ کنید	شرح
والدین	پایگاه داده	محل والدین
ارزش	ناشناخته	مقدار اختیاری که در مکان تولید شده نوشته شود.

برمی گرداند:

theneableereference

Promise و Reference ترکیبی ; حل و فصل هنگامی که نوشتن کامل است ، اما می تواند بلافاصله به عنوان Reference محل کودک استفاده شود.

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

OrderByChild (مسیر)

QueryConstraint جدید را ایجاد می کند که توسط کلید مشخص شده کودک سفارش می دهد.

نمایش داده شد فقط می توانند با یک کلید به طور همزمان سفارش دهند. فراخوانی orderByChild() چندین بار در همان پرس و جو یک خطا است.

نمایش داده های Firebase به شما امکان می دهد داده های خود را توسط هر کلید کودک در پرواز سفارش دهید. با این حال ، اگر از قبل می دانید که شاخص های شما چه خواهد بود ، می توانید برای عملکرد بهتر آنها را از طریق قانون .indexon در قوانین امنیتی خود تعریف کنید. برای اطلاعات بیشتر به https://firebase.google.com/docs/database/securance/indexing-data مراجعه کنید.

می توانید اطلاعات بیشتر در مورد orderByChild() را در داده های مرتب بخوانید .

امضا:

export declare function orderByChild(path: string): QueryConstraint;

مولفه های

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

برمی گرداند:

عملکرد (پرس و جو ، ...)

دریافت (پرس و جو)

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

امضا:

export declare function get(query: Query): Promise<DataSnapshot>;

مولفه های

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

برمی گرداند:

قول < dataSnapShot >

Promise ای که در صورت وجود یک مقدار در دسترس است ، به DataSnapshot نتیجه می رسد ، یا اگر مشتری نتواند یک مقدار را برگرداند (به عنوان مثال ، اگر سرور غیرقابل دسترسی باشد و هیچ چیزی ذخیره نشده باشد) رد می شود.

خاموش (پرس و جو، نوع رویداد، پاسخ به تماس)

یک پاسخ به تماس قبلی را که قبلاً با on*() مربوطه وصل شده است جدا می کند ( onValue onChildAdded ) شنونده. توجه: این روش توصیه شده برای حذف شنونده نیست. درعوض ، لطفاً از عملکرد برگشتی برگشتی از on* های مربوطه استفاده کنید.

برگشتی را که قبلاً on*() وصل شده بود جدا کنید . تماس off() در مورد شنونده والدین ، شنوندگان ثبت شده در گره های کودک را به طور خودکار حذف نمی کند ، off() نیز باید از هر کودک شنونده خواسته شود تا پاسخ تماس را حذف کنند.

اگر پاسخ به تماس مشخص نشده باشد ، تمام تماس های برگشتی برای رویداد مشخص شده حذف می شود. به همین ترتیب ، اگر هیچ EventType مشخص نشده باشد ، تمام تماس های تماس برای Reference حذف می شوند.

شنوندگان انفرادی همچنین می توانند با استناد به تماس های لغو اشتراک خود حذف شوند.

امضا:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو که شنونده در آن ثبت شده است.
نوع رویداد	نوع رویداد	یکی از رشته های زیر: "ارزش" ، "Child_added" ، "Child_changed" ، "Child_removed" یا "Child_moved". در صورت حذف ، تمام تماسهای برگشتی برای `Reference` حذف می شوند.
پاسخ به تماس	(عکس فوری: DataSnapShot ، پیشین نام: رشته \| تهی) => ناشناخته	عملکرد پاسخ به تماس که `on()` منتقل شده است یا `undefined` تا همه تماس های برگشتی را حذف کند.

برمی گرداند:

خالی

onchildadded (پرس و جو ، پاسخ به تماس ، CancelCallback)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

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

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

امضا:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، پیشین نام: رشته \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

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

onchildadded (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onchildadded (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onchildChanged (پرس و جو ، پاسخ به تماس ، لغو مکالمه)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

هنگامی که داده های ذخیره شده در کودک (یا هر یک از فرزندان آن) تغییر می کنند ، یک رویداد onChildChanged ایجاد می شود. توجه داشته باشید که یک رویداد تنها child_changed ممکن است نشان دهنده تغییرات متعدد در کودک باشد. DataSnapshot که به پاسخ به تماس منتقل شده است ، حاوی محتوای کودک جدید خواهد بود. برای اهداف سفارش ، پاسخ به تماس نیز یک آرگومان دوم منتقل می شود که رشته ای حاوی کلید کودک خواهر و برادر قبلی با مرتب سازی مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

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

onchildchanged (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onchildchanged (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onChildMoved (پرس و جو، پاسخ به تماس، لغو پاسخ تماس)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

هنگامی که ترتیب مرتب سازی کودک تغییر می کند به گونه ای که موقعیت آن نسبت به خواهر و برادرهای آن تغییر کند ، یک رویداد onChildMoved ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، برای داده های کودک منتقل شده خواهد بود. همچنین یک آرگومان دوم به تصویب می رسد که رشته ای حاوی کلید فرزند خواهر و برادر قبلی با مرتب سازی مرتب است ، یا اگر فرزند اول باشد null .

امضا:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

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

onchildmoved (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onchildmoved (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ، قبلی ChildName: String \| تهی) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onchildremoved (پرس و جو ، پاسخ به تماس ، CancelCallback)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

هر بار که کودک برداشته می شود ، یک رویداد onChildRemoved یک بار ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های قدیمی برای کودک حذف شده خواهد بود. کودک در صورت هر دو حذف می شود:

یک مشتری صریحاً با آن کودک یا یکی از اجداد خود تماس می remove() - مشتری با آن کودک یا یکی از اجداد خود تماس می set(null) - آن کودک همه فرزندان خود را برداشته است - یک پرس و جو وجود دارد که اکنون فیلتر می شود از کودک (زیرا این نوع مرتب سازی شده تغییر کرده است یا حداکثر حد ضربه زده شده است)

امضا:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

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

onchildremoved (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

یک مشتری صریحاً با آن کودک یا یکی از اجداد خود تماس می remove() - مشتری با آن کودک یا یکی از اجداد خود تماس می set(null) - آن کودک همه فرزندان خود را برداشته است - یک پرس و جو وجود دارد که اکنون فیلتر می شود از کودک (زیرا این نوع مرتب سازی شده تغییر کرده است یا حداکثر حد ضربه زده شده است)

امضا:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

onchildremoved (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

یک مشتری صریحاً با آن کودک یا یکی از اجداد خود تماس می remove() - مشتری با آن کودک یا یکی از اجداد خود تماس می set(null) - آن کودک همه فرزندان خود را برداشته است - یک پرس و جو وجود دارد که اکنون فیلتر می شود از کودک (زیرا این نوع مرتب سازی شده تغییر کرده است یا حداکثر حد ضربه زده شده است)

امضا:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا `null` در صورت فرزند اول ، منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

OnValue (پرس و جو ، پاسخ به تماس ، لغولکبله)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان ایجاد می شود و هر بار که داده ها تغییر می کنند دوباره شروع می شوند. DataSnapshot که به تماس تلفنی منتقل می شود ، برای مکانی است که on() در آن نامیده می شود. تا زمانی که کل محتویات هماهنگ نشود ، شروع نمی شود. اگر مکان داده ای نداشته باشد ، با یک DataSnapshot خالی ( val() null باز می گردد ).

امضا:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با DataSnapshot منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

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

OnValue (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با DataSnapshot منتقل می شود.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

OnValue (پرس و جو ، پاسخ به تماس ، لغولک ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

امضا:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	پرس و جو برای اجرا.
پاسخ به تماس	(عکس فوری: DataSnapShot ) => ناشناخته	پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با DataSnapshot منتقل می شود.
CancelCallback	(خطا: خطا) => ناشناخته	پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء `Error` منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها	گوش دادن به	شیئی که می تواند برای پیکربندی `onlyOnce` استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

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

پرس و جو (پرس و جو، محدودیت های پرس و جو)

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

امضا:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

مولفه های

پارامتر	تایپ کنید	شرح
پرس و جو	پرس و جو	نمونه پرس و جو برای استفاده به عنوان پایه ای برای محدودیت های جدید.
باز پرس و جو	بازپرسی []	لیست `QueryConstraint` S برای اعمال.

برمی گرداند:

پرس و جو

استثناها

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

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

ondisconnect (Ref)

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

امضا:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	پایگاه داده	مرجع اضافه کردن OnDisconnect باعث می شود.

برمی گرداند:

در حال اتصال

حذف (Ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

امضا:

export declare function remove(ref: DatabaseReference): Promise<void>;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	DatabaseReference	The location to remove.

برمی گرداند:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

امضا:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	DatabaseReference	The location to atomically modify.
transactionUpdate	(currentData: any) => unknown	A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If `undefined` is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
گزینه ها	TransactionOptions	An options object to configure transactions.

برمی گرداند:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

امضا:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	DatabaseReference	The location to write to.
ارزش	ناشناخته	The value to be written (string, number, boolean, object, array, or null).

برمی گرداند:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

امضا:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	DatabaseReference	The location to write to.
اولویت	رشته \| شماره \| خالی	The priority to be written (string, number, or null).

برمی گرداند:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

امضا:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	DatabaseReference	The location to write to.
ارزش	ناشناخته	The value to be written (string, number, boolean, object, array, or null).
اولویت	رشته \| شماره \| خالی	The priority to be written (string, number, or null).

برمی گرداند:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

امضا:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

مولفه های

پارامتر	تایپ کنید	شرح
مرجع	DatabaseReference	The location to write to.
ارزش های	هدف - شی	Object containing multiple values.

برمی گرداند:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

امضا:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر	تایپ کنید	شرح
ارزش	شماره \| رشته \| boolean \| خالی	The value to end at. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
کلید	رشته	The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

امضا:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر	تایپ کنید	شرح
ارزش	شماره \| رشته \| boolean \| خالی	The value to end before. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
کلید	رشته	The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

امضا:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر	تایپ کنید	شرح
ارزش	شماره \| رشته \| boolean \| خالی	The value to match for. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
کلید	رشته	The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

امضا:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر	تایپ کنید	شرح
ارزش	شماره \| رشته \| boolean \| خالی	The value to start after. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
کلید	رشته	The child key to start after. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

امضا:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر	تایپ کنید	شرح
ارزش	شماره \| رشته \| boolean \| خالی	The value to start at. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
کلید	رشته	The child key to start at. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند: