firebase-functions package

फायरबेस के लिए क्लाउड फ़ंक्शंस के लिए दूसरी पीढ़ी की एपीआई। यह एसडीके गहरे आयात का समर्थन करता है। उदाहरण के लिए, नेमस्पेस pubsub firebase-functions/v2 पर उपलब्ध है या सीधे firebase-functions/v2/pubsub से आयात किया जा सकता है। .

कार्य

समारोह विवरण
सेटग्लोबलऑप्शंस(विकल्प) दूसरी पीढ़ी के एसडीके का उपयोग करके लिखे गए सभी कार्यों के लिए डिफ़ॉल्ट विकल्प सेट करता है।

कक्षाओं

कक्षा विवरण
परिवर्तन स्थिति बदलने वाली घटनाओं के लिए क्लाउड फ़ंक्शंस इंटरफ़ेस, जैसे रीयलटाइम डेटाबेस या क्लाउड फायरस्टोर onWrite और onUpdate इवेंट। Change ऑब्जेक्ट के निर्माण के लिए उपयोग किए जाने वाले प्रारूप के बारे में अधिक जानकारी के लिए, नीचे देखें।

इंटरफेस

इंटरफेस विवरण
क्लाउडइवेंट (बीटा) एक CloudEventBase सर्वर रहित ईवेंट को एन्कोड करने के लिए एक क्रॉस-प्लेटफ़ॉर्म प्रारूप का आधार है। अधिक जानकारी के लिए, https://github.com/cloudevents/spec देखें।
क्लाउडफ़ंक्शन (बीटा) क्लाउडइवेंट्स के लिए एक हैंडलर।
इवेंटहैंडलर विकल्प अतिरिक्त फ़ील्ड जिन्हें किसी भी इवेंट-हैंडलिंग फ़ंक्शन पर सेट किया जा सकता है।
वैश्विक विकल्प GlobalOptions ऐसे विकल्प हैं जिन्हें पूरे प्रोजेक्ट में सेट किया जा सकता है। ये विकल्प HTTPS और इवेंट हैंडलिंग फ़ंक्शंस के लिए सामान्य हैं।

नेमस्पेस

नाम स्थान विवरण
अलर्ट
डेटाबेस
इवेंटआर्क
इस firestore
HTTPS के
पहचान
लकड़हारा
पैरामीटर
पबसब
रिमोट कॉन्फिग
अनुसूचक
भंडारण
कार्य
टेस्टलैब

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

उपनाम टाइप करें विवरण
प्रवेश सेटिंग IngressSettings के लिए उपलब्ध विकल्पों की सूची।
मेमोरी विकल्प क्लाउड फ़ंक्शंस द्वारा समर्थित उपलब्ध मेमोरी विकल्पों की सूची।
पैराम्सऑफ एक प्रकार जो सभी पैरामीटर कैप्चर ग्रोपस को रिकॉर्ड की कुंजियों में मैप करता है। उदाहरण के लिए, पैराम्सऑफ < "उपयोगकर्ता/ { यूआईडी } " > {uid: string } पैरामीटर्सऑफ़ है < "उपयोगकर्ता/ { यूआईडी } /लॉग/ { लकड़ी का लट्ठा } " > है { यूआईडी: स्ट्रिंग; लॉग: स्ट्रिंग }ParamsOf < "कुछ/स्थैतिक/डेटा" > है { } लचीलेपन के कारणों से, पैराम्सऑफ रिकार्ड है < स्ट्रिंग, स्ट्रिंग >
समर्थित क्षेत्र क्लाउड फ़ंक्शंस (दूसरी पीढ़ी) द्वारा समर्थित सभी क्षेत्रों की सूची।
VpcEgressSetting VpcConnectorEgressSettings के लिए उपलब्ध विकल्पों की सूची।

सेटग्लोबलऑप्शंस()

दूसरी पीढ़ी के एसडीके का उपयोग करके लिखे गए सभी कार्यों के लिए डिफ़ॉल्ट विकल्प सेट करता है।

हस्ताक्षर:

export declare function setGlobalOptions(options: GlobalOptions): void;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प वैश्विक विकल्प डिफ़ॉल्ट के रूप में सेट करने के विकल्प

रिटर्न:

खालीपन

प्रवेश सेटिंग

IngressSettings के लिए उपलब्ध विकल्पों की सूची .

हस्ताक्षर:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

मेमोरी विकल्प

क्लाउड फ़ंक्शंस द्वारा समर्थित उपलब्ध मेमोरी विकल्पों की सूची।

हस्ताक्षर:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

पैराम्सऑफ

एक प्रकार जो सभी पैरामीटर कैप्चर ग्रोपस को रिकॉर्ड की कुंजियों में मैप करता है। उदाहरण के लिए, पैराम्सऑफ < "उपयोगकर्ता/ { यूआईडी } " > {uid: string } पैरामीटर्सऑफ़ है < "उपयोगकर्ता/ { यूआईडी } /लॉग/ { लकड़ी का लट्ठा } " > है { यूआईडी: स्ट्रिंग; लॉग: स्ट्रिंग }ParamsOf < "कुछ/स्थैतिक/डेटा" > है { }

लचीलेपन के कारणों से, पैराम्सऑफ रिकार्ड है < स्ट्रिंग, स्ट्रिंग >

हस्ताक्षर:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

समर्थित क्षेत्र

क्लाउड फ़ंक्शंस (दूसरी पीढ़ी) द्वारा समर्थित सभी क्षेत्रों की सूची।

हस्ताक्षर:

export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";

VpcEgressSetting

VpcConnectorEgressSettings के लिए उपलब्ध विकल्पों की सूची .

हस्ताक्षर:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";