API generasi ke-2 untuk Cloud Functions for Firebase. SDK ini mendukung impor mendalam. Misalnya, namespace pubsub
tersedia di firebase-functions/v2
atau dapat langsung diimpor dari firebase-functions/v2/pubsub
.
Fungsi
Fungsi | Keterangan |
---|---|
setGlobalOptions(pilihan) | Menetapkan opsi default untuk semua fungsi yang ditulis menggunakan SDK generasi ke-2. |
Kelas
Kelas | Keterangan |
---|---|
Mengubah | Antarmuka Cloud Functions untuk peristiwa yang mengubah status, seperti peristiwa Realtime Database atau Cloud Firestore onWrite dan onUpdate . Untuk informasi selengkapnya tentang format yang digunakan untuk membuat objek Change , lihat di bawah. |
Antarmuka
Antarmuka | Keterangan |
---|---|
Acara Cloud | (BETA) CloudEventBase adalah dasar format lintas platform untuk menyandikan peristiwa tanpa server. Untuk informasi lebih lanjut, lihat https://github.com/cloudevents/spec. |
Fungsi Cloud | (BETA) Pengendali untuk CloudEvents. |
Opsi EventHandler | Bidang tambahan yang dapat diatur pada fungsi penanganan peristiwa apa pun. |
Opsi Global | GlobalOptions adalah opsi yang dapat diatur di seluruh proyek. Opsi ini umum untuk HTTPS dan fungsi penanganan kejadian. |
Ruang nama
Ruang nama | Keterangan |
---|---|
peringatan | |
basis data | |
acaraarc | |
toko api | |
https | |
identitas | |
penebang | |
param | |
pubsub | |
konfigurasi jarak jauh | |
penjadwal | |
penyimpanan | |
tugas | |
laboratorium uji |
Ketik Alias
Ketik Alias | Keterangan |
---|---|
Pengaturan Ingress | Daftar opsi yang tersedia untuk IngressSettings . |
Opsi Memori | Daftar opsi memori yang tersedia yang didukung oleh Cloud Functions. |
ParamsOf | Tipe yang memetakan semua parameter tangkapan gropus ke dalam kunci rekaman. Misalnya, ParamsOf < "pengguna/ { uid } " > adalah { uid: string } ParamsOf < "pengguna/ { uid } /log/ { catatan } " > adalah { uid: string; log: string } ParamsOf < "beberapa/statis/data" > adalah { } Untuk alasan fleksibilitas, ParamsOf |
Wilayah yang Didukung | Daftar semua region yang didukung oleh Cloud Functions (generasi ke-2). |
Pengaturan VpcEgress | Daftar opsi yang tersedia untuk VpcConnectorEgressSettings . |
setGlobalOptions()
Menetapkan opsi default untuk semua fungsi yang ditulis menggunakan SDK generasi ke-2.
Tanda tangan:
export declare function setGlobalOptions(options: GlobalOptions): void;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
pilihan | Opsi Global | Opsi untuk ditetapkan sebagai default |
Pengembalian:
ruang kosong
Pengaturan Ingress
Daftar opsi yang tersedia untuk IngressSettings
.
Tanda tangan:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
Opsi Memori
Daftar opsi memori yang tersedia yang didukung oleh Cloud Functions.
Tanda tangan:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
ParamsOf
Tipe yang memetakan semua parameter tangkapan gropus ke dalam kunci rekaman. Misalnya, ParamsOf < "pengguna/ { uid } " > adalah { uid: string } ParamsOf < "pengguna/ { uid } /log/ { catatan } " > adalah { uid: string; log: string } ParamsOf < "beberapa/statis/data" > adalah { }
Untuk alasan fleksibilitas, ParamsOf
Tanda tangan:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
Wilayah yang Didukung
Daftar semua region yang didukung oleh Cloud Functions (generasi ke-2).
Tanda tangan:
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";
Pengaturan VpcEgress
Daftar opsi yang tersedia untuk VpcConnectorEgressSettings
.
Tanda tangan:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";