Fungsi
| Fungsi | Keterangan |
|---|---|
| konfigurasi() | Simpan dan ambil data konfigurasi proyek seperti kunci API pihak ketiga atau pengaturan lainnya. Anda dapat menetapkan nilai konfigurasi menggunakan Firebase CLI seperti yang dijelaskan dalam [Konfigurasi Lingkungan](/docs/functions/config-env). |
| pilihanKeTitik Akhir(pilihan) | |
| optionsToTrigger(pilihan) | |
| wilayah (wilayah) | Konfigurasikan wilayah tempat fungsi tersebut diterapkan. |
| jalankanDengan(opsi runtime) | Konfigurasikan opsi runtime untuk fungsi tersebut. |
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. |
| Pembangun Fungsi |
Antarmuka
| Antarmuka | Keterangan |
|---|---|
| Fungsi Pemblokiran | Jenis fungsi untuk pemicu Pemblokiran Auth. |
| Fungsi Cloud | Jenis fungsi untuk semua pemicu non-HTTPS. Ini harus diekspor dari file JavaScript Anda untuk menentukan Cloud Function. Tipe ini adalah fungsi JavaScript khusus yang menggunakan objek Event yang diberi template sebagai satu-satunya argumennya. |
| Opsi Penerapan | Opsi konfigurasi untuk fungsi yang berlaku selama penerapan fungsi. |
| Peristiwa | Format kawat untuk suatu acara. |
| Konteks Acara | Konteks di mana suatu peristiwa terjadi. |
| Kebijakan Kegagalan | Opsi konfigurasi untuk kebijakan kegagalan pada fungsi latar belakang. |
| Fungsi Https | Jenis fungsi untuk pemicu HTTPS. Ini harus diekspor dari file JavaScript Anda untuk menentukan Cloud Function. |
| Sumber | Sumber daya adalah format standar untuk mendefinisikan sumber daya (google.rpc.context.AttributeContext.Resource). Di Cloud Functions, sumber dayalah yang memicu fungsi tersebut - seperti bucket penyimpanan. |
| Dapat dijalankan | Runnable memiliki metode run yang secara langsung memanggil fungsi yang ditentukan pengguna - berguna untuk pengujian unit. |
| Opsi Waktu Proses | Opsi konfigurasi untuk fungsi yang berlaku saat runtime. |
| Jadwal | Opsi konfigurasi untuk fungsi terjadwal. |
| JadwalCoba UlangConfig | Opsi coba lagi penjadwal. Hanya berlaku untuk fungsi terjadwal. |
Ruang nama
| Ruang nama | Keterangan |
|---|---|
| analitik | |
| autentik | |
| basis data | |
| toko api | |
| https | |
| penebang | |
| param | |
| pubsub | |
| konfigurasi jarak jauh | |
| penyimpanan | |
| tugas | |
| laboratorium uji |
Variabel
| Variabel | Keterangan |
|---|---|
| aplikasi | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | Daftar opsi yang tersedia untuk IngressSettings. |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | Nilai batas waktu maksimal Cloud Functions. |
| MIN_TIMEOUT_SECONDS | Nilai batas waktu minimum Cloud Functions. |
| RESET_VALUE | Nilai konfigurasi khusus untuk mengatur ulang konfigurasi ke default platform. |
| DIDUKUNG_REGIONS | Daftar semua wilayah yang didukung oleh Cloud Functions. |
| VALID_MEMORY_OPTIONS | Daftar opsi memori yang tersedia yang didukung oleh Cloud Functions. |
| VPC_EGRESS_SETTINGS_OPTIONS | Daftar opsi yang tersedia untuk VpcConnectorEgressSettings. |
konfigurasi()
Simpan dan ambil data konfigurasi proyek seperti kunci API pihak ketiga atau pengaturan lainnya. Anda dapat menetapkan nilai konfigurasi menggunakan Firebase CLI seperti yang dijelaskan dalam [Konfigurasi Lingkungan](/docs/functions/config-env).
Tanda tangan:
export declare function config(): Record<string, any>;
Pengembalian:
Rekam<string, apa saja>
opsiKeTitik Akhir()
Tanda tangan:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| pilihan | Opsi Penerapan |
Pengembalian:
Titik Akhir Manifes
opsiUntukPemicu()
Tanda tangan:
export declare function optionsToTrigger(options: DeploymentOptions): any;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| pilihan | Opsi Penerapan |
Pengembalian:
setiap
wilayah()
Konfigurasikan wilayah tempat fungsi tersebut diterapkan.
Tanda tangan:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| wilayah | Array<(typeof SUPPORTED_REGIONS )[angka] | tali | Ekspresi <string> | Nilai Ulang> | Salah satu dari lebih banyak string wilayah. |
Pengembalian:
Contoh 1
fungsi.wilayah('us-east1')
Contoh 2
fungsi.wilayah('us-timur1', 'us-pusat1')
dijalankanDengan()
Konfigurasikan opsi runtime untuk fungsi tersebut.
Tanda tangan:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| opsi runtime | Opsi Waktu Proses | Objek dengan kolom opsional: 1. memory : jumlah memori yang akan dialokasikan ke fungsi, nilai yang mungkin adalah: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', dan '8GB' . 2. timeoutSeconds : batas waktu untuk fungsi dalam hitungan detik, nilai yang mungkin adalah 0 hingga 540. 3. failurePolicy : kebijakan kegagalan fungsi, dengan boolean true setara dengan menyediakan objek percobaan ulang yang kosong. 4. vpcConnector : id konektor VPC di proyek dan wilayah yang sama. 5. vpcConnectorEgressSettings : ketika vpcConnector disetel, kendalikan lalu lintas keluar mana yang dikirim melalui vpcConnector. 6. serviceAccount : Akun layanan khusus untuk fungsi tersebut. 7. ingressSettings : pengaturan ingress untuk fungsi tersebut, yang mengontrol dari mana fungsi HTTPS dapat dipanggil. Nilai tidak boleh nol. |
Pengembalian:
aplikasi
Tanda tangan:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
Tanda tangan:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
Daftar opsi yang tersedia untuk IngressSettings.
Tanda tangan:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS
Tanda tangan:
MAX_NUMBER_USER_LABELS = 58
MAX_TIMEOUT_SECONDS
Nilai batas waktu maksimal Cloud Functions.
Tanda tangan:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Nilai batas waktu minimum Cloud Functions.
Tanda tangan:
MIN_TIMEOUT_SECONDS = 0
RESET_VALUE
Nilai konfigurasi khusus untuk mengatur ulang konfigurasi ke default platform.
Tanda tangan:
RESET_VALUE: ResetValue
DIDUKUNG_REGIONS
Daftar semua wilayah yang didukung oleh Cloud Functions.
Tanda tangan:
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"]
VALID_MEMORY_OPTIONS
Daftar opsi memori yang tersedia yang didukung oleh Cloud Functions.
Tanda tangan:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
Daftar opsi yang tersedia untuk VpcConnectorEgressSettings.
Tanda tangan:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]