https namespace

कार्य

समारोह विवरण
ऑनकॉल (ऑप्ट्स, हैंडलर) फायरबेस एसडीके का उपयोग करके कॉल करने के लिए ग्राहकों के लिए एक कॉल करने योग्य विधि की घोषणा करता है।
ऑनकॉल(हैंडलर) फायरबेस एसडीके का उपयोग करके कॉल करने के लिए ग्राहकों के लिए एक कॉल करने योग्य विधि की घोषणा करता है।
onRequest (ऑप्ट्स, हैंडलर) HTTPS अनुरोधों को संभालता है।
onRequest(हैंडलर) HTTPS अनुरोधों को संभालता है।

कक्षाओं

कक्षा विवरण
HTTPSत्रुटि एक स्पष्ट त्रुटि जिसे फ़ंक्शन को कॉल करने वाले क्लाइंट को त्रुटि भेजने के लिए हैंडलर से फेंका जा सकता है।

इंटरफेस

इंटरफेस विवरण
कॉल करने योग्य फ़ंक्शन फायरबेस एसडीके का उपयोग करके कॉल करने के लिए क्लाइंट के लिए एक कॉल करने योग्य विधि बनाता है।
कॉल करने योग्य विकल्प विकल्प जिन्हें कॉल करने योग्य HTTPS फ़ंक्शन पर सेट किया जा सकता है।
कॉल करने योग्य अनुरोध कॉल करने योग्य फ़ंक्शन को कॉल करने के लिए अनुरोध का उपयोग किया जाता है।
Httpsविकल्प विकल्प जिन्हें onRequest HTTPS फ़ंक्शन पर सेट किया जा सकता है।
अनुरोध अनुरोध निकाय के वायर प्रारूप प्रतिनिधित्व के साथ एक एक्सप्रेस अनुरोध।

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

उपनाम टाइप करें विवरण
फ़ंक्शंसत्रुटिकोड फायरबेस फ़ंक्शंस स्थिति कोड का सेट। जीआरपीसी द्वारा उजागर किए गए कोड समान हैं .
HTTPSफ़ंक्शन HTTPS अनुरोधों को संभालता है।

https.onCall()

फायरबेस एसडीके का उपयोग करके कॉल करने के लिए ग्राहकों के लिए एक कॉल करने योग्य विधि की घोषणा करता है।

हस्ताक्षर:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

पैरामीटर

पैरामीटर प्रकार विवरण
चुनता है कॉल करने योग्य विकल्प इस फ़ंक्शन पर सेट करने के लिए विकल्प.
हैंडलर (अनुरोध: CallableRequest <टी>) => वापसी एक फ़ंक्शन जो https.CallableRequest लेता है .

रिटर्न:

कॉल करने योग्य फ़ंक्शन <टी, रिटर्न>

एक फ़ंक्शन जिसे आप निर्यात और तैनात कर सकते हैं।

https.onCall()

फायरबेस एसडीके का उपयोग करके कॉल करने के लिए ग्राहकों के लिए एक कॉल करने योग्य विधि की घोषणा करता है।

हस्ताक्षर:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

पैरामीटर

पैरामीटर प्रकार विवरण
हैंडलर (अनुरोध: CallableRequest <टी>) => वापसी एक फ़ंक्शन जो https.CallableRequest लेता है .

रिटर्न:

कॉल करने योग्य फ़ंक्शन <टी, रिटर्न>

एक फ़ंक्शन जिसे आप निर्यात और तैनात कर सकते हैं।

https.onRequest()

HTTPS अनुरोधों को संभालता है।

हस्ताक्षर:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

पैरामीटर

पैरामीटर प्रकार विवरण
चुनता है Httpsविकल्प इस फ़ंक्शन पर सेट करने के लिए विकल्प
हैंडलर (अनुरोध: अनुरोध , प्रतिक्रिया: एक्सप्रेस.प्रतिक्रिया) => शून्य | वादा<शून्य> एक फ़ंक्शन जो https.Request और प्रतिक्रिया ऑब्जेक्ट लेता है, एक्सप्रेस ऐप के समान हस्ताक्षर।

रिटर्न:

HTTPSफ़ंक्शन

एक फ़ंक्शन जिसे आप निर्यात और तैनात कर सकते हैं।

https.onRequest()

HTTPS अनुरोधों को संभालता है।

हस्ताक्षर:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

पैरामीटर

पैरामीटर प्रकार विवरण
हैंडलर (अनुरोध: अनुरोध , प्रतिक्रिया: एक्सप्रेस.प्रतिक्रिया) => शून्य | वादा<शून्य> एक फ़ंक्शन जो https.Request और प्रतिक्रिया ऑब्जेक्ट लेता है, एक्सप्रेस ऐप के समान हस्ताक्षर।

रिटर्न:

HTTPSफ़ंक्शन

एक फ़ंक्शन जिसे आप निर्यात और तैनात कर सकते हैं।

https.FunctionsErrorCode

फायरबेस फ़ंक्शंस स्थिति कोड का सेट। जीआरपीसी द्वारा उजागर किए गए कोड समान हैं .

संभावित मान:

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

https.HttpsFunction

HTTPS अनुरोधों को संभालता है।

हस्ताक्षर:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};