firebase-functions package

फ़ंक्शन

फ़ंक्शन	ब्यौरा
config()	प्रोजेक्ट कॉन्फ़िगरेशन डेटा, जैसे कि तीसरे पक्ष की एपीआई कुंजियां या अन्य सेटिंग को सेव और हासिल करता है. Firebase सीएलआई का इस्तेमाल करके, कॉन्फ़िगरेशन वैल्यू सेट की जा सकती हैं. इसके बारे में [एनवायरमेंट कॉन्फ़िगरेशन](/docs/Functions/config-env) में बताया गया है.
optionsToEndpoint(विकल्प)
optionsToTrigger(विकल्प)
क्षेत्र(क्षेत्र)	उन क्षेत्रों को कॉन्फ़िगर करें जहां फ़ंक्शन को डिप्लॉय किया गया है.
runWith(runtimeOptions)	फ़ंक्शन के लिए रनटाइम के विकल्पों को कॉन्फ़िगर करें.

क्लास

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

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
ब्लॉक करने वाला फ़ंक्शन	पुष्टि करने की सुविधा वाले ट्रिगर के लिए फ़ंक्शन टाइप.
CloudFunction	बिना एचटीटीपीएस वाले सभी ट्रिगर के लिए फ़ंक्शन टाइप. Cloud फ़ंक्शन तय करने के लिए, इसे आपकी JavaScript फ़ाइल से एक्सपोर्ट किया जाना चाहिए.यह टाइप एक खास JavaScript फ़ंक्शन है, जो टेंप्लेट किए गए Event ऑब्जेक्ट को इसके लिए तर्क के तौर पर लेता है.
डिप्लॉयमेंट के विकल्प	फ़ंक्शन डिप्लॉयमेंट के दौरान लागू होने वाले फ़ंक्शन के लिए कॉन्फ़िगरेशन विकल्प.
इवेंट	किसी इवेंट के लिए वायर फ़ॉर्मैट.
EventContext	वह कॉन्टेक्स्ट जिसमें कोई इवेंट हुआ.
FailurePolicy	बैकग्राउंड के फ़ंक्शन के लिए, गड़बड़ी से जुड़ी नीति को कॉन्फ़िगर करने का विकल्प.
Httpsफ़ंक्शन	एचटीटीपीएस ट्रिगर के लिए फ़ंक्शन टाइप. Cloud फ़ंक्शन तय करने के लिए, इसे आपकी JavaScript फ़ाइल से एक्सपोर्ट किया जाना चाहिए.
संसाधन	संसाधन, किसी संसाधन (google.rpc.context.AttributeContext.Resource) को परिभाषित करने का एक मानक फ़ॉर्मैट होता है. Cloud Functions में, यह फ़ंक्शन को ट्रिगर करने वाला संसाधन है - जैसे कि स्टोरेज बकेट.
रनेबल	रनेबल में एक run तरीका होता है, जो उपयोगकर्ता के तय किए गए फ़ंक्शन को सीधे तौर पर शुरू करता है. यह फ़ंक्शन यूनिट टेस्टिंग के लिए काम का होता है.
रनटाइम के विकल्प	रनटाइम पर लागू होने वाले फ़ंक्शन के लिए कॉन्फ़िगरेशन के विकल्प.
शेड्यूल	शेड्यूल किए गए फ़ंक्शन के लिए कॉन्फ़िगरेशन के विकल्प.
Scheduleफिर से कॉन्फ़िगर करने की सुविधा	शेड्यूलर के लिए फिर से कोशिश करने के विकल्प. यह सिर्फ़ शेड्यूल किए गए फ़ंक्शन पर लागू होता है.

नाम स्थान

नाम-स्थान	ब्यौरा
Analytics
auth
डेटाबेस
फ़ायरस्टोर
https
लॉगर
पैरामीटर
pubsub
रिमोट कॉन्फ़िगरेशन
स्टोरेज
टास्क
टेस्टलैब

वैरिएबल

वैरिएबल	ब्यौरा
ऐप्लिकेशन
DEFAULT_noreply_POLICY
INGRESS_SETTINGS_OPTIONS	इन्ग्रेस डेटा ट्रैफ़िक के लिए उपलब्ध विकल्पों की सूची.
MAX_NUMBER_USER_लेबल
MAX_ फ़िल्म प्रति सेकंड	Cloud Functions देखने के लिए, ज़्यादा से ज़्यादा टाइम आउट की वैल्यू.
MIN_TIME_SECONDS	Cloud Functions देखने के लिए कम से कम टाइम आउट वैल्यू.
RESET_VALUE	कॉन्फ़िगरेशन को प्लैटफ़ॉर्म डिफ़ॉल्ट पर रीसेट करने के लिए, खास कॉन्फ़िगरेशन वैल्यू.
SUPPORTED_ मेट्रिक	Cloud Functions के साथ काम करने वाले सभी इलाकों की सूची.
वैलिड_MEMORY_OPTIONS	Cloud Functions के साथ काम करने वाले मेमोरी के उपलब्ध विकल्पों की सूची.
VPC_EGRESS_SETTINGS_OPTIONS	VpcConnectorEग्रेसSettings के लिए उपलब्ध विकल्पों की सूची.

config()

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

हस्ताक्षर:

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

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

रिकॉर्ड<string, कोई भी>

optionsToEndpoint()

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	डिप्लॉयमेंट के विकल्प

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

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

optionsToTrigger()

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	डिप्लॉयमेंट के विकल्प

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

कोई भी

क्षेत्र()

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
क्षेत्र	सरणी<(SUPPORTED_AREAS का प्रकार)[number] | स्ट्रिंग | एक्सप्रेशन<string> | रीसेट मान>	एक और क्षेत्र स्ट्रिंग.

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

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

उदाहरण 1

फ़ंक्शन.region('us-east1')

उदाहरण 2

फ़ंक्शन.region('us-east1', 'us-central1')

रनविद()

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

ऐप्लिकेशन

हस्ताक्षर:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FEATURE_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_लेबल

हस्ताक्षर:

MAX_NUMBER_USER_LABELS = 58

MAX_ फ़िल्म प्रति सेकंड

Cloud Functions देखने के लिए, ज़्यादा से ज़्यादा टाइम आउट की वैल्यू.

हस्ताक्षर:

MAX_TIMEOUT_SECONDS = 540

MIN_ फ़िल्म प्रति सेकंड

Cloud Functions देखने के लिए कम से कम टाइम आउट वैल्यू.

हस्ताक्षर:

MIN_TIMEOUT_SECONDS = 0

रीसेट करें

कॉन्फ़िगरेशन को प्लैटफ़ॉर्म डिफ़ॉल्ट पर रीसेट करने के लिए, खास कॉन्फ़िगरेशन वैल्यू.

हस्ताक्षर:

RESET_VALUE: ResetValue

SUPPORTED_क्षेत्र

Cloud Functions के साथ काम करने वाले सभी इलाकों की सूची.

हस्ताक्षर:

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

मान्य_MEMORY_OPTIONS

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

हस्ताक्षर:

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

VPC_EGRESS_SETTINGS_OPTIONS

VpcConnectorEग्रेसSettings के लिए उपलब्ध विकल्पों की सूची.

हस्ताक्षर:

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