firebase-functions package

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
config()	จัดเก็บและเรียกข้อมูลการกำหนดค่าโปรเจ็กต์ เช่น คีย์ API ของบุคคลที่สามหรือการตั้งค่าอื่นๆ คุณสามารถตั้งค่าการกำหนดค่าโดยใช้ Firebase CLI ตามที่อธิบายไว้ใน[การกำหนดค่าสภาพแวดล้อม](/docs/functions/config-env)
optionsToEndpoint(options)
optionsToTrigger(ตัวเลือก)
ภูมิภาค(ภูมิภาค)	กำหนดค่าภูมิภาคที่มีการทำให้ฟังก์ชันใช้งานได้
runWith(runtimeOptions)	กำหนดค่าตัวเลือกรันไทม์สำหรับฟังก์ชัน

ชั้นเรียน

ชั้น	คำอธิบาย
เปลี่ยน	อินเทอร์เฟซ Cloud Functions สำหรับเหตุการณ์ที่เปลี่ยนสถานะ เช่น Realtime Database หรือ Cloud Firestore onWrite และเหตุการณ์ onUpdateดูข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบที่ใช้สร้างออบเจ็กต์ Change ได้ที่ด้านล่าง
FunctionBuilder

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
BlockFunction	ประเภทฟังก์ชันสำหรับทริกเกอร์การบล็อกการตรวจสอบสิทธิ์
CloudFunction	ประเภทฟังก์ชันสำหรับทริกเกอร์ทั้งหมดที่ไม่ใช่ HTTPS ซึ่งควรส่งออกจากไฟล์ JavaScript เพื่อกำหนด Cloud Functionประเภทนี้เป็นฟังก์ชัน JavaScript พิเศษที่ใช้ออบเจ็กต์ Event ที่มีเทมเพลตเป็นอาร์กิวเมนต์เดียว
ตัวเลือกการทำให้ใช้งานได้	ตัวเลือกการกำหนดค่าสำหรับฟังก์ชันที่ใช้ระหว่างการทำให้ฟังก์ชันใช้งานได้
เหตุการณ์	รูปแบบสายสำหรับกิจกรรม
EventContext	บริบทที่เกิดเหตุการณ์ขึ้น
FailurePolicy	ตัวเลือกการกําหนดค่าสําหรับนโยบายความล้มเหลวเกี่ยวกับฟังก์ชันในเบื้องหลัง
HttpsFunction	ประเภทฟังก์ชันสำหรับทริกเกอร์ HTTPS ซึ่งควรส่งออกจากไฟล์ JavaScript เพื่อกำหนด Cloud Function
แหล่งข้อมูล	ทรัพยากรคือรูปแบบมาตรฐานสำหรับการกำหนดทรัพยากร (google.rpc.context.AttributeContext.Resource) ส่วนใน Cloud Functions จะเป็นทรัพยากรที่เรียกใช้ฟังก์ชัน เช่น ที่เก็บข้อมูลของพื้นที่เก็บข้อมูล
เรียกใช้ได้	การเรียกใช้ได้มีเมธอด run ซึ่งจะเรียกใช้ฟังก์ชันที่ผู้ใช้กำหนดโดยตรง ซึ่งมีประโยชน์สำหรับการทดสอบหน่วย
RuntimeOptions	ตัวเลือกการกำหนดค่าสำหรับฟังก์ชันที่ใช้ได้ขณะรันไทม์
กำหนดการ	ตัวเลือกการกำหนดค่าสำหรับฟังก์ชันที่กำหนดเวลาไว้
ScheduleRetryConfig	ตัวเลือกการลองใช้เครื่องจัดตารางเวลาอีกครั้ง ใช้กับฟังก์ชันที่กำหนดเวลาไว้เท่านั้น

เนมสเปซ

เนมสเปซ	คำอธิบาย
Analytics
การตรวจสอบสิทธิ์
ฐานข้อมูล
Firestore
https
ล็อกเกอร์
พารามิเตอร์
PubSub
remoteConfig
พื้นที่เก็บข้อมูล
งาน
testLab

ตัวแปร

ตัวแปร	คำอธิบาย
แอป
นโยบายไม่สำเร็จ
ตัวเลือกการตั้งค่า INGRESS	รายการตัวเลือกที่พร้อมใช้งานสำหรับ IngressSettings
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS	ค่าระยะหมดเวลาสูงสุดของ Cloud Functions
MIN_TIMEOUT_SECONDS	ค่าระยะหมดเวลาขั้นต่ำของ Cloud Functions
รีเซ็ตมูลค่า	ค่าการกำหนดค่าพิเศษเพื่อรีเซ็ตการกำหนดค่าเป็นค่าเริ่มต้นของแพลตฟอร์ม
ภูมิภาคที่รองรับ	รายชื่อภูมิภาคทั้งหมดที่ Cloud Functions รองรับ
MEMORY_OPTIONS ใช้งานได้	รายการตัวเลือกหน่วยความจำที่ใช้ได้ซึ่ง Cloud Functions รองรับ
VPC_EGRESS_SETTINGS_OPTIONS	รายการตัวเลือกที่ใช้ได้สำหรับ VpcConnectorEgressSettings

config()

จัดเก็บและเรียกข้อมูลการกำหนดค่าโปรเจ็กต์ เช่น คีย์ API ของบุคคลที่สามหรือการตั้งค่าอื่นๆ คุณสามารถตั้งค่าการกำหนดค่าโดยใช้ Firebase CLI ตามที่อธิบายไว้ใน[การกำหนดค่าสภาพแวดล้อม](/docs/functions/config-env)

ลายเซ็น:

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

การคืนสินค้า:

บันทึก<สตริง, อะไรก็ได้>

optionsToEndpoint()

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวเลือก	ตัวเลือกการทำให้ใช้งานได้

การคืนสินค้า:

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_REGIONS)[number] | สตริง | นิพจน์<string> | รีเซ็ตค่า>	สตริงภูมิภาคอย่างน้อย 1 รายการ

การคืนสินค้า:

FunctionBuilder

ตัวอย่างที่ 1

Functions.region('us-east1')

ตัวอย่างที่ 2

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

RunWith()

กำหนดค่าตัวเลือกรันไทม์สำหรับฟังก์ชัน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวเลือกรันไทม์	RuntimeOptions	ออบเจ็กต์ที่มีช่องที่ไม่บังคับ: 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 ได้จากที่ใดค่าต้องไม่เป็น Null

การคืนสินค้า:

FunctionBuilder

แอป

ลายเซ็น:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

ลายเซ็น:

DEFAULT_FAILURE_POLICY: FailurePolicy

ตัวเลือกการตั้งค่า INGRESS

รายการตัวเลือกที่พร้อมใช้งานสำหรับ IngressSettings

ลายเซ็น:

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

ค่าระยะหมดเวลาสูงสุดของ Cloud Functions

ลายเซ็น:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

ค่าระยะหมดเวลาขั้นต่ำของ Cloud Functions

ลายเซ็น:

MIN_TIMEOUT_SECONDS = 0

รีเซ็ต

ค่าการกำหนดค่าพิเศษเพื่อรีเซ็ตการกำหนดค่าเป็นค่าเริ่มต้นของแพลตฟอร์ม

ลายเซ็น:

RESET_VALUE: ResetValue

ภูมิภาคที่รองรับ

รายชื่อภูมิภาคทั้งหมดที่ 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

รายการตัวเลือกที่ใช้ได้สำหรับ VpcConnectorEgressSettings

ลายเซ็น:

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