Firebase के लिए Cloud Functions
फ़ंक्शन
| फ़ंक्शन | ब्यौरा |
|---|---|
| फ़ंक्शन(ऐप्लिकेशन, ...) | |
| getFunctions(ऐप्लिकेशन, RegionOrCustomDomain) | दिए गए ऐप्लिकेशन के लिए Functions इंस्टेंस दिखाता है. |
| फ़ंक्शन(फ़ंक्शन इंस्टेंस, ...) | |
| connectFunctionsEmulator(Functions प्रोफ़ाइल, होस्ट, पोर्ट) | Cloud Functions एम्युलेटर से संपर्क करने के लिए, इस इंस्टेंस में बदलाव करें.ध्यान दें: किसी भी कार्रवाई के लिए इस इंस्टेंस का इस्तेमाल करने से पहले, इस इंस्टेंस को कॉल किया जाना चाहिए. |
| httpsCallable(FunctionsInstance, name, options) | दिए गए नाम से कॉल किए जा सकने वाले एचटीटीपीएस ट्रिगर का रेफ़रंस दिखाता है. |
| httpsCallableFromURL(FunctionsInstance, url, options) | तय किए गए यूआरएल के साथ कॉल करने लायक एचटीटीपीएस ट्रिगर का रेफ़रंस देता है. |
इंटरफ़ेस
| इंटरफ़ेस | ब्यौरा |
|---|---|
| फ़ंक्शन | Functions इंस्टेंस. |
| फ़ंक्शन से जुड़ी गड़बड़ी | Firebase Functions क्लाइंट SDK टूल से एक गड़बड़ी मिली है. |
| HttpsCallableOptions | कॉल चलाने के तरीके के बारे में मेटाडेटा के लिए इंटरफ़ेस. |
| एचटीटीपीएस कॉल करने लायक नतीजा | HttpsCallableResult फ़ंक्शन कॉल से मिले एक नतीजे को रैप करता है. |
उपनामों का प्रकार
| उपनाम टाइप करें | ब्यौरा |
|---|---|
| FunctionsErrorCode | Firebase फ़ंक्शन के स्टेटस कोड का सेट. gRPC के ज़रिए दिखाए गए कोड यहां एक जैसे हैं: https://github.com/grpc/grpc/blob/Master/doc/statuscodes.mdसंभावित वैल्यू: - 'cancelled': कार्रवाई रद्द कर दी गई है (आम तौर पर कॉलर की ओर से). - 'जानकारी नहीं है': ऐसी गड़बड़ी या किसी दूसरे गड़बड़ी डोमेन की गड़बड़ी. - 'अमान्य तर्क': क्लाइंट ने कोई अमान्य तर्क बताया है. ध्यान दें कि यह 'पहले से तय की गई शर्त' से अलग है. 'अमान्य-तर्क' यह ऐसे तर्क को दिखाता है जिनमें सिस्टम की स्थिति की परवाह किए बिना समस्या होती है (उदाहरण के लिए, किसी फ़ील्ड का अमान्य नाम). - 'समयसीमा खत्म हो गई है': कार्रवाई पूरी होने से पहले समयसीमा खत्म हो गई है. सिस्टम की स्थिति बदलने वाले ऑपरेशन के लिए, यह गड़बड़ी दिखाई जा सकती है, भले ही कार्रवाई पूरी तरह से पूरी हो गई हो. उदाहरण के लिए, हो सकता है कि सर्वर से सही जवाब मिलने में ज़्यादा समय लगे और समयसीमा खत्म होने में देरी हो. - 'नहीं मिला': अनुरोध किया गया कुछ दस्तावेज़ नहीं मिला. - 'पहले से मौजूद है': हमने जो दस्तावेज़ बनाने की कोशिश की थी वह पहले से मौजूद है. - 'अनुमति नहीं दी गई': कॉलर के पास बताए गए ऑपरेशन को लागू करने की अनुमति नहीं है. - 'संसाधन खत्म': कुछ संसाधन खत्म हो गए हैं. ऐसा शायद हर उपयोगकर्ता के लिए कोटा खत्म हो गया हो या पूरे फ़ाइल सिस्टम में जगह न बची हो. - 'पहले से तय की गई शर्त': ऑपरेशन को अस्वीकार कर दिया गया था क्योंकि सिस्टम कार्रवाई के निष्पादन के लिए ज़रूरी स्थिति में नहीं है. - 'रद्द किया गया': आम तौर पर, लेन-देन रद्द होने जैसी किसी एक साथ काम करने की समस्या की वजह से कार्रवाई रद्द कर दी जाती है. - 'सीमा से बाहर': सही सीमा से बाहर जाने की कोशिश की गई. - 'लागू नहीं है': ऑपरेशन लागू नहीं किया गया है या काम नहीं करता/चालू नहीं है. - 'इंटरनल': अंदरूनी गड़बड़ियां. इसका मतलब है कि मौजूदा सिस्टम से उम्मीद के मुताबिक कुछ इन्वैरिएंट काम नहीं कर रहे हैं. अगर आपको इनमें से कोई एक गड़बड़ी दिखती है, तो इसका मतलब है कि कुछ ठीक से काम नहीं कर रहा है. - 'उपलब्ध नहीं है': यह सेवा फ़िलहाल उपलब्ध नहीं है. यह स्थिति थोड़े समय के लिए होती है और इसे ठीक करने के लिए, बैकऑफ़ के साथ फिर से कोशिश करें. - 'डेटा-लॉस': डेटा को वापस नहीं पाया जा सकता या खराब हो गया. - 'अप्रमाणित': कार्रवाई के लिए अनुरोध में मान्य प्रमाणीकरण क्रेडेंशियल नहीं हैं. |
| FunctionsErrorCodeCore | फ़ंक्शन की गड़बड़ी वाले कोड की स्ट्रिंग, "फ़ंक्शन/" के बाद जुड़ती है प्रॉडक्ट प्रीफ़िक्स का इस्तेमाल करें. कोड के पूरे दस्तावेज़ देखने के लिए, FunctionsErrorCode देखें. |
| एचटीटीपीएस से कॉल किया जा सकता है | "कॉल करने लायक" का रेफ़रंस Google Cloud Functions में एचटीटीपी ट्रिगर. |
फ़ंक्शन(ऐप्लिकेशन, ...)
getFunctions(ऐप्लिकेशन, RegionOrCustomDomain)
दिए गए ऐप्लिकेशन के लिए Functions इंस्टेंस दिखाता है.
हस्ताक्षर:
export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| ऐप्लिकेशन | FirebaseApp | इस्तेमाल करने के लिए FirebaseApp. |
| क्षेत्र या कस्टम डोमेन | स्ट्रिंग | इनमें से एक: a) वह क्षेत्र जहां कॉल करने लायक फ़ंक्शन मौजूद हैं (उदाहरण: us-central1) b) कॉल किए जा सकने वाले फ़ंक्शन को होस्ट करने वाला कस्टम डोमेन (उदाहरण: https://mydomain.com) |
लौटाए जाने वाले प्रॉडक्ट:
फ़ंक्शन(फ़ंक्शनइंस्टेंस, ...)
ConnectFunctionsEmulator(FunctionsInstance, होस्ट, पोर्ट)
Cloud Functions एम्युलेटर से संपर्क करने के लिए इस इंस्टेंस में बदलाव करें.
हस्ताक्षर:
export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| फ़ंक्शन इंस्टेंस | फ़ंक्शन | |
| होस्ट | स्ट्रिंग | एम्युलेटर होस्ट (उदाहरण: localhost) |
| पोर्ट | नंबर | एम्युलेटर पोर्ट (उदाहरण: 5001) |
लौटाए जाने वाले प्रॉडक्ट:
अमान्य
httpsCallable(FunctionsInstance, name, options)
दिए गए नाम से कॉल किए जा सकने वाले एचटीटीपीएस ट्रिगर का रेफ़रंस दिखाता है.
हस्ताक्षर:
export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| फ़ंक्शन इंस्टेंस | फ़ंक्शन | |
| नाम | स्ट्रिंग | ट्रिगर का नाम. |
| विकल्प | HttpsCallableOptions |
लौटाए जाने वाले प्रॉडक्ट:
Https कॉल करने लायक<RequestData, ResponseData>
httpsCallableFromURL(FunctionsInstance, url, options)
तय किए गए यूआरएल के साथ कॉल करने लायक एचटीटीपीएस ट्रिगर का रेफ़रंस देता है.
हस्ताक्षर:
export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| फ़ंक्शन इंस्टेंस | फ़ंक्शन | |
| url | स्ट्रिंग | ट्रिगर का यूआरएल. |
| विकल्प | HttpsCallableOptions |
लौटाए जाने वाले प्रॉडक्ट:
Https कॉल करने लायक<RequestData, ResponseData>
फ़ंक्शन गड़बड़ी कोड
Firebase फ़ंक्शन के स्टेटस कोड का सेट. यहां gRPC के ज़रिए दिखाए गए कोड एक जैसे हैं: https://github.com/grpc/grpc/blob/Master/doc/statuscodes.md
संभावित मान: - 'रद्द किया गया': कार्रवाई रद्द कर दी गई थी (आम तौर पर कॉलर की ओर से). - 'जानकारी नहीं है': ऐसी गड़बड़ी या किसी दूसरे गड़बड़ी डोमेन की गड़बड़ी. - 'अमान्य तर्क': क्लाइंट ने कोई अमान्य तर्क बताया है. ध्यान दें कि यह 'पहले से तय की गई शर्त' से अलग है. 'अमान्य-तर्क' यह ऐसे तर्क को दिखाता है जिनमें सिस्टम की स्थिति की परवाह किए बिना समस्या होती है (उदाहरण के लिए, किसी फ़ील्ड का अमान्य नाम). - 'समयसीमा खत्म हो गई है': कार्रवाई पूरी होने से पहले समयसीमा खत्म हो गई है. सिस्टम की स्थिति बदलने वाले ऑपरेशन के लिए, यह गड़बड़ी दिखाई जा सकती है, भले ही कार्रवाई पूरी तरह से पूरी हो गई हो. उदाहरण के लिए, हो सकता है कि सर्वर से सही जवाब मिलने में ज़्यादा समय लगे और समयसीमा खत्म होने में देरी हो. - 'नहीं मिला': अनुरोध किया गया कुछ दस्तावेज़ नहीं मिला. - 'पहले से मौजूद है': हमने जो दस्तावेज़ बनाने की कोशिश की थी वह पहले से मौजूद है. - 'अनुमति नहीं दी गई': कॉलर के पास बताए गए ऑपरेशन को लागू करने की अनुमति नहीं है. - 'संसाधन खत्म': कुछ संसाधन खत्म हो गए हैं. ऐसा शायद हर उपयोगकर्ता के लिए कोटा खत्म हो गया हो या पूरे फ़ाइल सिस्टम में जगह न बची हो. - 'पहले से तय की गई शर्त': ऑपरेशन को अस्वीकार कर दिया गया था क्योंकि सिस्टम कार्रवाई के निष्पादन के लिए ज़रूरी स्थिति में नहीं है. - 'रद्द किया गया': आम तौर पर, लेन-देन रद्द होने जैसी किसी एक साथ काम करने की समस्या की वजह से कार्रवाई रद्द कर दी जाती है. - 'सीमा से बाहर': सही सीमा से बाहर जाने की कोशिश की गई. - 'लागू नहीं है': ऑपरेशन लागू नहीं किया गया है या काम नहीं करता/चालू नहीं है. - 'इंटरनल': अंदरूनी गड़बड़ियां. इसका मतलब है कि मौजूदा सिस्टम से उम्मीद के मुताबिक कुछ इन्वैरिएंट काम नहीं कर रहे हैं. अगर आपको इनमें से कोई एक गड़बड़ी दिखती है, तो इसका मतलब है कि कुछ ठीक से काम नहीं कर रहा है. - 'उपलब्ध नहीं है': यह सेवा फ़िलहाल उपलब्ध नहीं है. यह स्थिति थोड़े समय के लिए होती है और इसे ठीक करने के लिए, बैकऑफ़ के साथ फिर से कोशिश करें. - 'डेटा-लॉस': डेटा को वापस नहीं पाया जा सकता या खराब हो गया. - 'अप्रमाणित': कार्रवाई के लिए अनुरोध में मान्य प्रमाणीकरण क्रेडेंशियल नहीं हैं.
हस्ताक्षर:
export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
फ़ंक्शन गड़बड़ी कोडकोर
फ़ंक्शन की गड़बड़ी वाले कोड की स्ट्रिंग, "फ़ंक्शन/" के बाद जुड़ती है प्रॉडक्ट प्रीफ़िक्स का इस्तेमाल करें. कोड के पूरे दस्तावेज़ देखने के लिए, 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 Cloud Functions में एचटीटीपी ट्रिगर.
हस्ताक्षर:
export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;