API generasi ke-2 untuk Cloud Functions for Firebase. SDK ini mendukung impor mendalam. Misalnya, namespace pubsub tersedia di firebase-functions/v2 atau dapat diimpor langsung dari firebase-functions/v2/pubsub.
Functions
| Fungsi | Deskripsi |
|---|---|
| setGlobalOptions(opsi) | Menetapkan opsi default untuk semua fungsi yang ditulis menggunakan SDK generasi ke-2. |
Kelas
| Class | Deskripsi |
|---|---|
| Ubah | Antarmuka Cloud Functions untuk peristiwa yang mengubah status, seperti peristiwa onWrite dan onUpdate Realtime Database atau Cloud Firestore.Untuk mengetahui informasi selengkapnya tentang format yang digunakan untuk membuat objek Change, lihat di bawah. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| CloudEvent | (BETA) CloudEventBase adalah dasar format lintas platform untuk mengenkode peristiwa serverless. Untuk informasi selengkapnya, lihat https://github.com/cloudevents/spec. |
| CloudFunction | (BETA) Pengendali untuk CloudEvents. |
| EventHandlerOptions | Kolom tambahan yang dapat ditetapkan pada fungsi penanganan peristiwa apa pun. |
| GlobalOptions | GlobalOptions adalah opsi yang dapat ditetapkan di seluruh project. Opsi ini umum untuk fungsi penanganan peristiwa dan HTTPS. |
Namespace
| Namespace | Deskripsi |
|---|---|
| pemberitahuan | |
| database | |
| eventarc | |
| firestore | |
| https | |
| identitas | |
| logger | |
| parameter | |
| pubsub | |
| remoteConfig | |
| penjadwal | |
| penyimpanan | |
| tugas | |
| testLab |
Ketik Alias
| Ketik Alias | Deskripsi |
|---|---|
| Setelan Masuk | Daftar opsi yang tersedia untuk IngressSettings. |
| MemoryOption | Daftar opsi memori yang tersedia dan didukung oleh Cloud Functions. |
| ParamsOf | Jenis yang memetakan semua gropus pengambilan parameter ke dalam kunci kumpulan data. Misalnya, ParamsOf<"users/{uid}"> adalah { uid: string } ParamsOf<"users/{uid}/logs/{log}"> adalah { uid: string; log: string } ParamsOf<"some/static/data"> adalah {}Untuk alasan fleksibilitas, ParamsOf |
| DidukungRegion | Daftar semua region yang didukung oleh Cloud Functions (generasi ke-2). |
| Setelan 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 | Deskripsi |
|---|---|---|
| opsi | GlobalOptions | Opsi untuk ditetapkan sebagai default |
Hasil:
void
Setelan Ingress
Daftar opsi yang tersedia untuk IngressSettings.
Tanda Tangan:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
OpsiMemori
Daftar opsi memori yang tersedia dan didukung oleh Cloud Functions.
Tanda Tangan:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
Parameter
Jenis yang memetakan semua gropus pengambilan parameter ke dalam kunci kumpulan data. Misalnya, ParamsOf<"users/{uid}"> adalah { uid: string } ParamsOf<"users/{uid}/logs/{log}"> adalah { uid: string; log: string } ParamsOf<"some/static/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;
};
DidukungRegion
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";
Setelan VpcEgress
Daftar opsi yang tersedia untuk VpcConnectorEgressSettings.
Tanda Tangan:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";