کارکرد
| تابع | شرح |
|---|---|
| onCall (کنترل کننده) | یک روش فراخوانی را برای مشتریان اعلام می کند تا با استفاده از Firebase SDK تماس بگیرند. |
| onRequest (کنترل کننده) | رسیدگی به درخواست های HTTP |
کلاس ها
| کلاس | شرح |
|---|---|
| HttpsError | یک خطای صریح که می تواند از یک کنترل کننده برای ارسال خطایی به کلاینتی که تابع را فراخوانی می کند، پرتاب شود. |
رابط ها
| رابط | شرح |
|---|---|
| CallableContext | رابط برای ابرداده برای API که به کنترل کننده منتقل می شود. |
| درخواست | یک درخواست سریع با فرمت سیمی بدنه درخواست. |
نام مستعار را تایپ کنید
| نام مستعار را تایپ کنید | شرح |
|---|---|
| FunctionsErrorCode | مجموعه کدهای وضعیت توابع Firebase. کدهایی که توسط gRPC در معرض دید قرار می گیرند یکسان هستند . |
https.onCall()
یک روش فراخوانی را برای مشتریان اعلام می کند تا با استفاده از Firebase SDK تماس بگیرند.
امضا:
export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (داده: هر، زمینه: CallableContext ) => هر | قول <هر> | متدی که یک داده و زمینه را می گیرد و یک مقدار را برمی گرداند. |
برمی گرداند:
HttpsFunction & Runnable <هر>
https.onRequest()
رسیدگی به درخواست های HTTP
امضا:
export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (قیمت: درخواست، پاسخ: express.Response) => void | قول<باطل> | تابعی که یک شی درخواست و پاسخ، امضای مشابه یک برنامه Express را می گیرد. |
برمی گرداند:
https.FunctionsErrorCode
مجموعه کدهای وضعیت توابع Firebase. کدهایی که توسط gRPC در معرض دید قرار می گیرند یکسان هستند .
مقادیر ممکن:
cancelled: عملیات لغو شد (معمولاً توسط تماس گیرنده).unknown: خطای ناشناخته یا خطایی از دامنه خطای دیگری.invalid-argument: کلاینت آرگومان نامعتبری را مشخص کرده است. توجه داشته باشید که این باfailed-preconditionمتفاوت است .invalid-argumentآرگومان هایی را نشان می دهد که بدون توجه به وضعیت سیستم مشکل ساز هستند (مثلاً نام فیلد نامعتبر).deadline-exceeded: مهلت قبل از تکمیل عملیات به پایان رسیده است. برای عملیاتی که وضعیت سیستم را تغییر می دهد، حتی اگر عملیات با موفقیت به پایان رسیده باشد، ممکن است این خطا برگردانده شود. به عنوان مثال، یک پاسخ موفقیت‌آمیز از یک سرور می‌توانست آنقدر به تأخیر بیفتد که مهلت آن به پایان برسد.not-found: برخی از اسناد درخواستی یافت نشد.already-exists: برخی از اسنادی که سعی کردیم ایجاد کنیم، از قبل وجود دارد.permission-denied: تماس گیرنده مجوز اجرای عملیات مشخص شده را ندارد.resource-exhausted: برخی از منابع تمام شده است، شاید سهمیه هر کاربر، یا شاید کل سیستم فایل خالی است.failed-precondition: عملیات رد شد زیرا سیستم در وضعیت لازم برای اجرای عملیات نیست.aborted: این عملیات معمولاً به دلیل یک مسئله همزمانی مانند سقط تراکنش و غیره متوقف شد.out-of-range: عملیات از محدوده معتبر گذشته است.unimplemented: عملیات اجرا نمی شود یا پشتیبانی نمی شود/فعال می شود.internal: خطاهای داخلی به این معنی که برخی از متغیرهای مورد انتظار سیستم زیربنایی شکسته شده است. اگر یکی از این خطاها را مشاهده کردید، چیزی بسیار خراب است.unavailable: این سرویس در حال حاضر در دسترس نیست. این به احتمال زیاد یک وضعیت گذرا است و ممکن است با تلاش مجدد با عقب نشینی اصلاح شود.data-loss: از دست دادن یا خرابی داده غیرقابل جبران.unauthenticated: درخواست دارای اعتبار احراز هویت معتبر برای عملیات نیست.
امضا:
export type FunctionsErrorCode = "ok" | "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";