functions package

फायरबेस के लिए क्लाउड फ़ंक्शंस

कार्य

इंटरफेस

उपनाम टाइप करें

फ़ंक्शन (ऐप, ...)

getFunctions(ऐप, क्षेत्रयाकस्टमडोमेन)

दिए गए ऐप के लिए फ़ंक्शंस उदाहरण लौटाता है।

हस्ताक्षर:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): 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>;

पैरामीटर

रिटर्न:

Httpsकॉल करने योग्य <अनुरोध डेटा, प्रतिक्रिया डेटा>

httpsCallableFromURL(functionsInstance, url, विकल्प)

निर्दिष्ट यूआरएल के साथ कॉल करने योग्य HTTPS ट्रिगर का संदर्भ लौटाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

Httpsकॉल करने योग्य <अनुरोध डेटा, प्रतिक्रिया डेटा>

फ़ंक्शंसत्रुटिकोड

फायरबेस फ़ंक्शंस स्थिति कोड का सेट। यहां जीआरपीसी द्वारा उजागर किए गए कोड समान हैं: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

संभावित मान: - 'रद्द': ऑपरेशन रद्द कर दिया गया था (आमतौर पर कॉल करने वाले द्वारा)। - 'अज्ञात': अज्ञात त्रुटि या किसी भिन्न त्रुटि डोमेन से त्रुटि। - 'अमान्य-तर्क': क्लाइंट ने एक अमान्य तर्क निर्दिष्ट किया। ध्यान दें कि यह 'असफल-पूर्व शर्त' से भिन्न है। 'अमान्य-तर्क' उन तर्कों को इंगित करता है जो सिस्टम की स्थिति की परवाह किए बिना समस्याग्रस्त हैं (उदाहरण के लिए एक अमान्य फ़ील्ड नाम)। - 'समय सीमा समाप्त': ऑपरेशन पूरा होने से पहले ही समय सीमा समाप्त हो गई। सिस्टम की स्थिति को बदलने वाले ऑपरेशनों के लिए, यह त्रुटि वापस आ सकती है, भले ही ऑपरेशन सफलतापूर्वक पूरा हो गया हो। उदाहरण के लिए, सर्वर से एक सफल प्रतिक्रिया में समय सीमा समाप्त होने में काफी देरी हो सकती है। - 'नहीं मिला': कुछ अनुरोधित दस्तावेज़ नहीं मिला। - 'पहले से मौजूद है': कुछ दस्तावेज़ जिन्हें हमने बनाने का प्रयास किया था वे पहले से मौजूद हैं। - 'अनुमति-अस्वीकृत': कॉल करने वाले के पास निर्दिष्ट ऑपरेशन निष्पादित करने की अनुमति नहीं है। - 'संसाधन समाप्त': कुछ संसाधन समाप्त हो गए हैं, शायद प्रति-उपयोगकर्ता कोटा, या शायद संपूर्ण फ़ाइल सिस्टम स्थान से बाहर है। - 'विफल-पूर्व शर्त': ऑपरेशन को अस्वीकार कर दिया गया क्योंकि सिस्टम ऑपरेशन के निष्पादन के लिए आवश्यक स्थिति में नहीं है। - 'निरस्त': ऑपरेशन निरस्त कर दिया गया था, आमतौर पर लेन-देन निरस्त होने आदि जैसी समवर्ती समस्या के कारण। - 'आउट-ऑफ-रेंज': ऑपरेशन को वैध सीमा से परे करने का प्रयास किया गया था। - 'कार्यान्वित': ऑपरेशन क्रियान्वित नहीं है या समर्थित/सक्षम नहीं है। - 'आंतरिक': आंतरिक त्रुटियाँ। इसका मतलब है कि अंतर्निहित प्रणाली द्वारा अपेक्षित कुछ अपरिवर्तनीयताएँ टूट गई हैं। यदि आप इनमें से एक त्रुटि देखते हैं, तो कुछ बहुत टूटा हुआ है। - 'अनुपलब्ध': सेवा वर्तमान में अनुपलब्ध है। यह संभवतः एक क्षणिक स्थिति है और इसे बैकऑफ़ के साथ पुनः प्रयास करके ठीक किया जा सकता है। - 'डेटा-हानि': अप्राप्य डेटा हानि या भ्रष्टाचार। - 'अप्रमाणित': अनुरोध में ऑपरेशन के लिए वैध प्रमाणीकरण क्रेडेंशियल नहीं हैं।

हस्ताक्षर:

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

फ़ंक्शंसErrorCodeCore

फ़ंक्शन त्रुटि कोड स्ट्रिंग "फ़ंक्शन/" उत्पाद उपसर्ग के बाद जोड़ी गई। कोड के पूर्ण दस्तावेज़ीकरण के लिए 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';

Httpsकॉल करने योग्य

Google क्लाउड फ़ंक्शंस में "कॉल करने योग्य" HTTP ट्रिगर का संदर्भ।

हस्ताक्षर:

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