फ़ंक्शन
फ़ंक्शन | ब्यौरा |
---|---|
ऑनकॉल(हैंडलर) | इससे क्लाइंट को कॉल करने के लिए, Firebase SDK टूल का इस्तेमाल करके कॉल करने का तरीका बताया जाता है. |
onRequest(हैंडलर) | एचटीटीपी अनुरोधों को मैनेज करना. |
क्लास
क्लास | ब्यौरा |
---|---|
HttpsError | यह एक ऐसी गड़बड़ी होती है जो किसी हैंडलर से आसानी से आ सकती है. इससे, क्लाइंट को वह गड़बड़ी भेजी जा सकती है जिसे फ़ंक्शन कॉल किया जाता है. |
इंटरफ़ेस
इंटरफ़ेस | ब्यौरा |
---|---|
कॉल करने लायक कॉन्टेक्स्ट | एपीआई के लिए, हैंडलर को पास किए गए मेटाडेटा के लिए इंटरफ़ेस. |
अनुरोध करें | अनुरोध के मुख्य हिस्से की वायर फ़ॉर्मैट वाली इमेज के साथ साफ़ अनुरोध. |
उपनामों का प्रकार
उपनाम टाइप करें | ब्यौरा |
---|---|
FunctionsErrorCode | Firebase फ़ंक्शन के स्टेटस कोड का सेट. दोनों कोड एक जैसे होते हैं, जिनके बारे में gRPC ने जानकारी दी है. |
https.onCall()
इससे क्लाइंट को कॉल करने के लिए, Firebase SDK टूल का इस्तेमाल करके कॉल करने का तरीका बताया जाता है.
हस्ताक्षर:
export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
हैंडलर | (डेटा: कोई भी, कॉन्टेक्स्ट: CallableContext) => कोई भी | वादा करें<किसी भी> | यह ऐसा तरीका है जो डेटा और कॉन्टेक्स्ट को लेकर कोई वैल्यू दिखाता है. |
लौटाए जाने वाले प्रॉडक्ट:
HttpsFunction और चलाया जा सकता है<कोई भी>
https.onRequest()
एचटीटीपी अनुरोधों को मैनेज करना.
हस्ताक्षर:
export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
हैंडलर | (अनुरोध: अनुरोध, sp: express.Response) => अमान्य | प्रॉमिस<void> | यह एक ऐसा फ़ंक्शन है जो अनुरोध और रिस्पॉन्स ऑब्जेक्ट के हस्ताक्षर को स्वीकार करता है. यह हस्ताक्षर एक्सप्रेस ऐप्लिकेशन में होता है. |
लौटाए जाने वाले प्रॉडक्ट:
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";