https namespace

کارکرد

کلاس ها

رابط ها

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

https.onCall()

یک روش فراخوانی را برای مشتریان اعلام می کند تا با استفاده از Firebase SDK تماس بگیرند.

امضا:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

مولفه های

برمی گرداند:

CallableFunction<T, Return>

تابعی که می توانید آن را صادر و اجرا کنید.

https.onCall()

یک روش فراخوانی را برای مشتریان اعلام می کند تا با استفاده از Firebase SDK تماس بگیرند.

امضا:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

مولفه های

برمی گرداند:

CallableFunction<T, Return>

تابعی که می توانید آن را صادر و اجرا کنید.

https.onRequest()

درخواست های HTTPS را رسیدگی می کند.

امضا:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

مولفه های

برمی گرداند:

HttpsFunction

تابعی که می توانید آن را صادر و اجرا کنید.

https.onRequest()

درخواست های HTTPS را رسیدگی می کند.

امضا:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

مولفه های

برمی گرداند:

HttpsFunction

تابعی که می توانید آن را صادر و اجرا کنید.

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

https.HttpsFunction

درخواست های HTTPS را رسیدگی می کند.

امضا:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};