firebase-functions package

API รุ่นที่ 2 สำหรับฟังก์ชั่นคลาวด์สำหรับ Firebase SDK นี้รองรับการนำเข้าเชิงลึก ตัวอย่างเช่น เนมสเปซ pubsub มีอยู่ที่ firebase-functions/v2 หรือนำเข้าได้โดยตรงจาก firebase-functions/v2/pubsub .

ฟังก์ชั่น

การทำงาน คำอธิบาย
setGlobalOptions(ตัวเลือก) ตั้งค่าตัวเลือกเริ่มต้นสำหรับฟังก์ชันทั้งหมดที่เขียนโดยใช้ SDK รุ่นที่ 2

ชั้นเรียน

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

อินเทอร์เฟซ

อินเตอร์เฟซ คำอธิบาย
คลาวด์อีเว้นท์ (เบต้า) CloudEventBase เป็นพื้นฐานของรูปแบบข้ามแพลตฟอร์มสำหรับการเข้ารหัสเหตุการณ์แบบไร้เซิร์ฟเวอร์ สำหรับข้อมูลเพิ่มเติม โปรดดู https://github.com/cloudevents/spec
คลาวด์ฟังก์ชัน (เบต้า) ตัวจัดการสำหรับ CloudEvents
ตัวเลือกตัวจัดการเหตุการณ์ ฟิลด์เพิ่มเติมที่สามารถตั้งค่าได้ในฟังก์ชันการจัดการเหตุการณ์ใดๆ
GlobalOptions GlobalOptions เป็นตัวเลือกที่สามารถตั้งค่าได้ทั่วทั้งโครงการ ตัวเลือกเหล่านี้เป็นเรื่องปกติสำหรับ HTTPS และฟังก์ชันการจัดการเหตุการณ์

เนมสเปซ

เนมสเปซ คำอธิบาย
การแจ้งเตือน
ฐานข้อมูล
เหตุการณ์
ร้านขายไฟ
https
ตัวตน
คนตัดไม้
พารามิเตอร์
ผับซับ
การกำหนดค่าระยะไกล
กำหนดการ
พื้นที่จัดเก็บ
งาน
ทดสอบแล็บ

พิมพ์นามแฝง

พิมพ์นามแฝง คำอธิบาย
การตั้งค่าทางเข้า รายการตัวเลือกที่ใช้ได้สำหรับ IngressSettings
หน่วยความจำตัวเลือก รายการตัวเลือกหน่วยความจำที่ใช้งานได้ซึ่งรองรับโดย Cloud Functions
พารามิเตอร์ของ ประเภทที่แมปกลุ่มการจับพารามิเตอร์ทั้งหมดลงในคีย์ของเรกคอร์ด ตัวอย่างเช่น ParamsOf < "ผู้ใช้/ { uid } " > คือ { uid: string } ParamsOf < "ผู้ใช้/ { uid } /บันทึก/ { บันทึก } " > คือ { uid: string; บันทึก: สตริง } ParamsOf < "บางส่วน/คงที่/ข้อมูล" > คือ { } เพื่อเหตุผลด้านความยืดหยุ่น ParamsOf คือบันทึก < เชือก, เชือก >
ภูมิภาคที่รองรับ รายชื่อภูมิภาคทั้งหมดที่รองรับโดย Cloud Functions (รุ่นที่ 2)
การตั้งค่า VpcEgress รายการตัวเลือกที่ใช้ได้สำหรับ VpcConnectorEgressSettings

setGlobalOptions()

ตั้งค่าตัวเลือกเริ่มต้นสำหรับฟังก์ชันทั้งหมดที่เขียนโดยใช้ SDK รุ่นที่ 2

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
ตัวเลือก GlobalOptions ตัวเลือกเพื่อตั้งเป็นค่าเริ่มต้น

ผลตอบแทน:

เป็นโมฆะ

การตั้งค่าทางเข้า

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

ลายเซ็น:

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

หน่วยความจำตัวเลือก

รายการตัวเลือกหน่วยความจำที่ใช้งานได้ซึ่งรองรับโดย Cloud Functions

ลายเซ็น:

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

พารามิเตอร์ของ

ประเภทที่แมปกลุ่มการจับพารามิเตอร์ทั้งหมดลงในคีย์ของเรกคอร์ด ตัวอย่างเช่น ParamsOf < "ผู้ใช้/ { uid } " > คือ { uid: string } ParamsOf < "ผู้ใช้/ { uid } /บันทึก/ { บันทึก } " > คือ { uid: string; บันทึก: สตริง } ParamsOf < "บางส่วน/คงที่/ข้อมูล" > คือ { }

เพื่อเหตุผลด้านความยืดหยุ่น ParamsOf คือบันทึก < เชือก, เชือก >

ลายเซ็น:

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

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

รายชื่อภูมิภาคทั้งหมดที่รองรับโดย Cloud Functions (รุ่นที่ 2)

ลายเซ็น:

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

การตั้งค่า VpcEgress

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

ลายเซ็น:

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