functions package

وظائف السحابة لـ Firebase

المهام

واجهات

اكتب الأسماء المستعارة

وظيفة (التطبيق، ...)

getFunctions(app, RegionOrCustomDomain)

إرجاع مثيل وظائف للتطبيق المحدد.

إمضاء:

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

حدود

عائدات:

المهام

وظيفة (وظائف مثيل، ...)

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

حدود

عائدات:

httpCallable <بيانات الطلب، بيانات الاستجابة>

httpsCallableFromURL(functionsInstance، url، خيارات)

يُرجع مرجعًا إلى مشغل HTTPS القابل للاستدعاء بعنوان URL المحدد.

إمضاء:

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

حدود

عائدات:

httpCallable <بيانات الطلب، بيانات الاستجابة>

وظائف خطأ رمز

مجموعة رموز حالة وظائف Firebase. الرموز هي نفسها التي كشفها gRPC هنا: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

القيم المحتملة: - "تم الإلغاء": تم إلغاء العملية (عادة بواسطة المتصل). - 'غير معروف': خطأ غير معروف أو خطأ من مجال خطأ مختلف. - "وسيطة غير صالحة": حدد العميل وسيطة غير صالحة. لاحظ أن هذا يختلف عن "الشرط المسبق الفاشل". تشير "الوسيطة غير الصالحة" إلى الوسائط التي تمثل مشكلة بغض النظر عن حالة النظام (على سبيل المثال، اسم حقل غير صالح). - "تم تجاوز الموعد النهائي": انتهى الموعد النهائي قبل أن تكتمل العملية. بالنسبة للعمليات التي تغير حالة النظام، قد يتم إرجاع هذا الخطأ حتى لو اكتملت العملية بنجاح. على سبيل المثال، قد يتم تأخير الاستجابة الناجحة من الخادم لفترة كافية حتى انتهاء الموعد النهائي. - "غير موجود": لم يتم العثور على بعض المستندات المطلوبة. - "موجود بالفعل": بعض المستندات التي حاولنا إنشاءها موجودة بالفعل. - "تم رفض الإذن": ليس لدى المتصل إذن بتنفيذ العملية المحددة. - "استنفاد الموارد": تم استنفاد بعض الموارد، ربما حصة لكل مستخدم، أو ربما نظام الملفات بأكمله غير متوفر في المساحة. - "فشل الشرط المسبق": تم رفض العملية لأن النظام ليس في الحالة المطلوبة لتنفيذ العملية. - 'تم إحباط': تم إحباط العملية، عادةً بسبب مشكلة في التزامن مثل إحباط المعاملة، وما إلى ذلك. - 'خارج النطاق': تمت محاولة العملية بعد النطاق الصالح. - "غير منفذة": لم يتم تنفيذ العملية أو أنها غير مدعومة/ممكّنة. - 'داخلي': أخطاء داخلية. يعني أن بعض الثوابت المتوقعة من النظام الأساسي قد تم كسرها. إذا رأيت أحد هذه الأخطاء، فهذا يعني أن هناك شيئًا مكسورًا للغاية. - "غير متاح": الخدمة غير متاحة حاليًا. من المرجح أن تكون هذه حالة عابرة ويمكن تصحيحها عن طريق إعادة المحاولة مع التراجع. - "فقدان البيانات": فقدان البيانات أو تلفها بشكل غير قابل للاسترداد. - "غير مصادق عليه": لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.

إمضاء:

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