firebase-functions package

Firebase के लिए Cloud Functions के लिए, 2nd gen API. इस SDK टूल की मदद से, डेटा को डीप इंपोर्ट किया जा सकता है. उदाहरण के लिए, नेमस्पेस pubsub firebase-functions/v2 पर उपलब्ध है या इसे firebase-functions/v2/pubsub से सीधे इंपोर्ट किया जा सकता है.

फ़ंक्शन

फ़ंक्शन	ब्यौरा
setGlobalOptions(विकल्प)	2nd gen के SDK टूल का इस्तेमाल करके लिखे गए सभी फ़ंक्शन के लिए, डिफ़ॉल्ट विकल्प सेट करता है.

क्लास

क्लास	ब्यौरा
बदलें	स्थिति बदलने वाले इवेंट के लिए Cloud Functions इंटरफ़ेस, जैसे कि रीयलटाइम डेटाबेस या Cloud Firestore onWrite और onUpdate इवेंट.Change ऑब्जेक्ट को बनाने में इस्तेमाल किए गए फ़ॉर्मैट के बारे में ज़्यादा जानकारी के लिए, नीचे देखें.

इंटरफ़ेस

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

नाम स्थान

नाम-स्थान	ब्यौरा
सूचनाएं
डेटाबेस
इवेंटर्क
फ़ायरस्टोर
https
आइडेंटिटी
लॉगर
पैरामीटर
pubsub
रिमोट कॉन्फ़िगरेशन
शेड्यूलर
स्टोरेज
टास्क
टेस्टलैब

उपनामों का प्रकार

उपनाम टाइप करें	ब्यौरा
इन्ग्रेस सेटिंग	IngressSettings के लिए उपलब्ध विकल्पों की सूची.
MemoryOption	Cloud Functions के साथ काम करने वाले मेमोरी के उपलब्ध विकल्पों की सूची.
पैराम्सऑफ़	एक ऐसा टाइप जो सभी पैरामीटर कैप्चर ग्रोपस को रिकॉर्ड की कुंजियों के तौर पर मैप करता है. उदाहरण के लिए, ParamsOf<"users/{uid}"> यह { uid: String } ParamsOf<"users/{uid}/logs/{log}"> है है { uid: स्ट्रिंग; Log: String } ParamsOf<"some/static/data"> यह है {}ज़रूरत के हिसाब से, ParamsOf रिकॉर्ड है<string, string>
सहायता क्षेत्र	Cloud Functions (2nd gen) के साथ काम करने वाले सभी क्षेत्रों की सूची.
VpcEग्रेसSettings	VpcConnectorEgressSettings के लिए उपलब्ध विकल्पों की सूची.

setGlobalOptions()

2nd gen के SDK टूल का इस्तेमाल करके लिखे गए सभी फ़ंक्शन के लिए, डिफ़ॉल्ट विकल्प सेट करता है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	ग्लोबल विकल्प	डिफ़ॉल्ट के तौर पर सेट करने के विकल्प

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

इन्ग्रेसिंग सेटिंग

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

हस्ताक्षर:

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

MemoryOption

Cloud Functions के साथ काम करने वाले मेमोरी के उपलब्ध विकल्पों की सूची.

हस्ताक्षर:

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

पैरामीटर ऑफ़

एक ऐसा टाइप जो सभी पैरामीटर कैप्चर ग्रोपस को रिकॉर्ड की कुंजियों के तौर पर मैप करता है. उदाहरण के लिए, ParamsOf<"users/{uid}"> यह { uid: String } ParamsOf<"users/{uid}/logs/{log}"> है यह { uid: स्ट्रिंग; Log: स्ट्रिंग } ParamsOf<"some/static/data"> {} है

लचीलेपन की वजह से, ParamsOf is Recorder<string, String>

हस्ताक्षर:

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

इस इलाके में काम करती है

Cloud Functions (2nd gen) के साथ काम करने वाले सभी क्षेत्रों की सूची.

हस्ताक्षर:

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

VpcEग्रेससेटिंग

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

हस्ताक्षर:

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