functions package

توابع ابری برای Firebase

کارکرد

رابط ها

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

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

getFunctions (برنامه، regionOrCustomDomain)

یک نمونه توابع را برای برنامه داده شده برمی گرداند.

امضا:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

مولفه های

برمی گرداند:

کارکرد

تابع (functionsInstance، ...)

connectFunctionsEmulator (functionsInstance، میزبان، پورت)

این نمونه را برای برقراری ارتباط با شبیه ساز Cloud Functions تغییر دهید.

امضا:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

مولفه های

برمی گرداند:

خالی

httpsCallable (functionsInstance، نام، گزینه‌ها)

ارجاعی به محرک HTTPS قابل تماس با نام داده شده را برمی گرداند.

امضا:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

مولفه های

برمی گرداند:

HttpsCallable <RequestData, ResponseData>

httpsCallableFromURL(functionsInstance، url، گزینه ها)

ارجاعی به راه‌انداز HTTPS قابل تماس با نشانی اینترنتی مشخص شده برمی‌گرداند.

امضا:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

مولفه های

برمی گرداند:

HttpsCallable <RequestData, ResponseData>

FunctionsErrorCode

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

مقادیر ممکن: - 'لغو': عملیات لغو شد (معمولاً توسط تماس گیرنده). - 'ناشناخته': خطای ناشناخته یا خطایی از یک دامنه خطای دیگر. - 'invalid-argument': کلاینت یک آرگومان نامعتبر را مشخص کرده است. توجه داشته باشید که این با "پیش شرط شکست خورده" متفاوت است. 'invalid-argument' آرگومان هایی را نشان می دهد که بدون توجه به وضعیت سیستم مشکل ساز هستند (مثلاً نام فیلد نامعتبر). - 'deadline-exceeded': مهلت قبل از تکمیل عملیات منقضی شده است. برای عملیاتی که وضعیت سیستم را تغییر می دهد، حتی اگر عملیات با موفقیت به پایان رسیده باشد، ممکن است این خطا برگردانده شود. به عنوان مثال، یک پاسخ موفقیت‌آمیز از یک سرور می‌توانست آنقدر به تأخیر بیفتد که مهلت آن به پایان برسد. - 'نیافتاده': برخی از اسناد درخواستی یافت نشد. - "از قبل وجود دارد": برخی از اسنادی که ما سعی کردیم ایجاد کنیم، از قبل وجود دارد. - "مجوز رد شده": تماس گیرنده مجوز اجرای عملیات مشخص شده را ندارد. - "منبع تمام شده": برخی از منابع تمام شده است، شاید سهمیه هر کاربر، یا شاید کل سیستم فایل خالی است. - 'failed-precondition': عملیات رد شد زیرا سیستم در وضعیت لازم برای اجرای عملیات نیست. - 'aborted': عملیات متوقف شد، معمولاً به دلیل یک مشکل همزمانی مانند سقط تراکنش، و غیره - 'خارج از محدوده': عملیات از محدوده معتبر گذشته است. - 'unmplemented': عملیات اجرا نمی شود یا پشتیبانی نمی شود/فعال می شود. - 'داخلی': خطاهای داخلی. به این معنی که برخی از متغیرهای مورد انتظار سیستم زیربنایی شکسته شده است. اگر یکی از این خطاها را مشاهده کردید، چیزی بسیار خراب است. - 'unavailable': این سرویس در حال حاضر در دسترس نیست. این به احتمال زیاد یک وضعیت گذرا است و ممکن است با تلاش مجدد با عقب نشینی اصلاح شود. - "از دست دادن داده": از دست دادن یا فساد غیرقابل جبران داده. - 'unauthenticated': درخواست اعتبار احراز هویت معتبر برای عملیات ندارد.

امضا:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

توابعErrorCodeCore

رشته کد خطای توابع پس از پیشوند محصول "functions/" اضافه شده است. برای مستندات کامل کدها به FunctionsErrorCode مراجعه کنید.

امضا:

export declare type FunctionsErrorCodeCore = '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';

HttpsCallable

ارجاع به یک راه‌انداز HTTP «قابل تماس» در Google Cloud Functions.

امضا:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;