firebase-functions package

कार्य

समारोह विवरण
कॉन्फिग() प्रोजेक्ट कॉन्फ़िगरेशन डेटा जैसे तृतीय-पक्ष एपीआई कुंजी या अन्य सेटिंग्स को संग्रहीत और पुनः प्राप्त करें। आप [पर्यावरण कॉन्फ़िगरेशन](/docs/functions/config-env) में वर्णित अनुसार फायरबेस सीएलआई का उपयोग करके कॉन्फ़िगरेशन मान सेट कर सकते हैं।
विकल्पटूएंडपॉइंट(विकल्प)
विकल्पटूट्रिगर(विकल्प)
क्षेत्र(क्षेत्र) उन क्षेत्रों को कॉन्फ़िगर करें जहां फ़ंक्शन तैनात किया गया है।
रनविथ(रनटाइम विकल्प) फ़ंक्शन के लिए रनटाइम विकल्प कॉन्फ़िगर करें।

कक्षाओं

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

इंटरफेस

इंटरफेस विवरण
ब्लॉकिंगफ़ंक्शन ऑथ ब्लॉकिंग ट्रिगर्स के लिए फ़ंक्शन प्रकार।
क्लाउडफ़ंक्शन सभी गैर-HTTPS ट्रिगर्स के लिए फ़ंक्शन प्रकार। क्लाउड फ़ंक्शन को परिभाषित करने के लिए इसे आपकी जावास्क्रिप्ट फ़ाइल से निर्यात किया जाना चाहिए। यह प्रकार एक विशेष जावास्क्रिप्ट फ़ंक्शन है जो टेम्पलेटेड Event ऑब्जेक्ट को अपने एकमात्र तर्क के रूप में लेता है।
परिनियोजन विकल्प किसी फ़ंक्शन के लिए कॉन्फ़िगरेशन विकल्प जो फ़ंक्शन परिनियोजन के दौरान लागू होते हैं।
आयोजन किसी इवेंट के लिए वायर प्रारूप.
इवेंट कॉन्टेक्स्ट वह संदर्भ जिसमें कोई घटना घटी.
विफलता नीति पृष्ठभूमि कार्यों पर विफलता नीति के लिए कॉन्फ़िगरेशन विकल्प।
HTTPSफ़ंक्शन HTTPS ट्रिगर्स के लिए फ़ंक्शन प्रकार। क्लाउड फ़ंक्शन को परिभाषित करने के लिए इसे आपकी जावास्क्रिप्ट फ़ाइल से निर्यात किया जाना चाहिए।
संसाधन संसाधन किसी संसाधन को परिभाषित करने के लिए एक मानक प्रारूप है (google.rpc.context.AttributeContext.Resource)। क्लाउड फ़ंक्शंस में, यह वह संसाधन है जो फ़ंक्शन को ट्रिगर करता है - जैसे स्टोरेज बकेट।
चलाने योग्य रननेबल में एक run विधि होती है जो सीधे उपयोगकर्ता द्वारा परिभाषित फ़ंक्शन को आमंत्रित करती है - इकाई परीक्षण के लिए उपयोगी।
रनटाइम विकल्प किसी फ़ंक्शन के लिए कॉन्फ़िगरेशन विकल्प जो रनटाइम पर लागू होते हैं।
अनुसूची निर्धारित कार्यों के लिए कॉन्फ़िगरेशन विकल्प.
शेड्यूलरिट्रीकॉन्फिग शेड्यूलर पुनः प्रयास विकल्प. केवल निर्धारित कार्यों पर लागू होता है।

नेमस्पेस

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

चर

चर विवरण
अनुप्रयोग
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS इनग्रेससेटिंग्स के लिए उपलब्ध विकल्पों की सूची।
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS क्लाउड फ़ंक्शंस अधिकतम टाइमआउट मान।
MIN_TIMEOUT_SECONDS क्लाउड फ़ंक्शंस न्यूनतम टाइमआउट मान।
रीसेट_मान कॉन्फ़िगरेशन को प्लेटफ़ॉर्म डिफ़ॉल्ट पर रीसेट करने के लिए विशेष कॉन्फ़िगरेशन मान।
समर्थित_क्षेत्र क्लाउड फ़ंक्शंस द्वारा समर्थित सभी क्षेत्रों की सूची।
वैध_मेमोरी_विकल्प क्लाउड फ़ंक्शंस द्वारा समर्थित उपलब्ध मेमोरी विकल्पों की सूची।
VPC_EGRESS_SETTINGS_OPTIONS VpcConnectorEgressSettings के लिए उपलब्ध विकल्पों की सूची।

कॉन्फिग()

प्रोजेक्ट कॉन्फ़िगरेशन डेटा जैसे तृतीय-पक्ष एपीआई कुंजी या अन्य सेटिंग्स को संग्रहीत और पुनः प्राप्त करें। आप [पर्यावरण कॉन्फ़िगरेशन](/docs/functions/config-env) में वर्णित अनुसार फायरबेस सीएलआई का उपयोग करके कॉन्फ़िगरेशन मान सेट कर सकते हैं।

हस्ताक्षर:

export declare function config(): Record<string, any>;

रिटर्न:

रिकॉर्ड<स्ट्रिंग, कोई भी>

विकल्पटूएंडपॉइंट()

हस्ताक्षर:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प परिनियोजन विकल्प

रिटर्न:

मेनिफेस्टएंडपॉइंट

विकल्पटूट्रिगर()

हस्ताक्षर:

export declare function optionsToTrigger(options: DeploymentOptions): any;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प परिनियोजन विकल्प

रिटर्न:

कोई

क्षेत्र()

उन क्षेत्रों को कॉन्फ़िगर करें जहां फ़ंक्शन तैनात किया गया है।

हस्ताक्षर:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

पैरामीटर

पैरामीटर प्रकार विवरण
क्षेत्रों सारणी<( SUPPORTED_REGIONS का प्रकार )[संख्या] | स्ट्रिंग | अभिव्यक्ति <स्ट्रिंग> | रीसेटवैल्यू> अधिक क्षेत्र स्ट्रिंग में से एक.

रिटर्न:

फ़ंक्शनबिल्डर

उदाहरण 1

फ़ंक्शन.क्षेत्र('us-east1')

उदाहरण 2

function.region('us-east1', 'us-central1')

साथ चलाएं()

फ़ंक्शन के लिए रनटाइम विकल्प कॉन्फ़िगर करें.

हस्ताक्षर:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

पैरामीटर

पैरामीटर प्रकार विवरण
रनटाइम विकल्प रनटाइम विकल्प वैकल्पिक फ़ील्ड के साथ ऑब्जेक्ट: 1. memory : फ़ंक्शन को आवंटित करने के लिए मेमोरी की मात्रा, संभावित मान हैं: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', और '8GB' . 2. timeoutSeconds : सेकंड में फ़ंक्शन के लिए टाइमआउट, संभावित मान 0 से 540 हैं। 3. failurePolicy : फ़ंक्शन की विफलता नीति, बूलियन true एक खाली पुनः प्रयास ऑब्जेक्ट प्रदान करने के बराबर है। 4. vpcConnector : समान प्रोजेक्ट और क्षेत्र में VPC कनेक्टर की आईडी। 5. vpcConnectorEgressSettings : जब एक vpcConnector सेट किया जाता है, तो नियंत्रित करें कि vpcConnector के माध्यम से कौन सा निकास ट्रैफ़िक भेजा जाता है। 6. serviceAccount : फ़ंक्शन के लिए विशिष्ट सेवा खाता। 7. ingressSettings : फ़ंक्शन के लिए इनग्रेस सेटिंग्स, जो नियंत्रित करती हैं कि HTTPS फ़ंक्शन को कहां से कॉल किया जा सकता है। मान शून्य नहीं होना चाहिए.

रिटर्न:

फ़ंक्शनबिल्डर

अनुप्रयोग

हस्ताक्षर:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

हस्ताक्षर:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

इनग्रेससेटिंग्स के लिए उपलब्ध विकल्पों की सूची।

हस्ताक्षर:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

हस्ताक्षर:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

क्लाउड फ़ंक्शंस अधिकतम टाइमआउट मान।

हस्ताक्षर:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

क्लाउड फ़ंक्शंस न्यूनतम टाइमआउट मान।

हस्ताक्षर:

MIN_TIMEOUT_SECONDS = 0

रीसेट_मान

कॉन्फ़िगरेशन को प्लेटफ़ॉर्म डिफ़ॉल्ट पर रीसेट करने के लिए विशेष कॉन्फ़िगरेशन मान।

हस्ताक्षर:

RESET_VALUE: ResetValue

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

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

हस्ताक्षर:

SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]

वैध_मेमोरी_विकल्प

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

हस्ताक्षर:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

VPC_EGRESS_SETTINGS_OPTIONS

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

हस्ताक्षर:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]