firebase-functions package

Functions

Fungsi Deskripsi
config() Simpan dan ambil data konfigurasi project seperti kunci API pihak ketiga atau setelan lainnya. Anda dapat menetapkan nilai konfigurasi menggunakan Firebase CLI seperti yang dijelaskan di [Konfigurasi Lingkungan](/docs/functions/config-env).
optionsToEndpoint(opsi)
optionsToTrigger(opsi)
region) Konfigurasi region tempat fungsi di-deploy.
runWith(runtimeOptions) Konfigurasi opsi runtime untuk fungsi.

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.
FunctionBuilder

Antarmuka

Antarmuka Deskripsi
BlockingFunction Jenis fungsi untuk pemicu Pemblokiran Auth.
CloudFunction Jenis fungsi untuk semua pemicu non-HTTPS. Ini harus diekspor dari file JavaScript Anda untuk menentukan Cloud Function.Jenis ini adalah fungsi JavaScript khusus yang menggunakan objek Event dengan template sebagai satu-satunya argumen.
DeploymentOptions Opsi konfigurasi untuk fungsi yang berlaku selama deployment fungsi.
Acara Format transfer bank untuk peristiwa.
EventContext Konteks saat peristiwa terjadi.
FailurePolicy Opsi konfigurasi untuk kebijakan kegagalan pada fungsi latar belakang.
HttpsFunction Jenis fungsi untuk pemicu HTTPS. Fungsi ini harus diekspor dari file JavaScript Anda untuk menentukan Cloud Function.
Resource Resource adalah format standar untuk menentukan resource (google.rpc.context.AttributeContext.Resource). Di Cloud Functions, ini adalah resource yang memicu fungsi, seperti bucket penyimpanan.
Dapat dijalankan Runnable memiliki metode run yang secara langsung memanggil fungsi yang ditentukan pengguna - berguna untuk pengujian unit.
RuntimeOptions Opsi konfigurasi untuk fungsi yang berlaku saat runtime.
Jadwal Opsi konfigurasi untuk fungsi terjadwal.
ScheduleRetryConfig Opsi coba lagi Scheduler. Hanya berlaku untuk fungsi terjadwal.

Namespace

Namespace Deskripsi
analisis
autentikasi
database
firestore
https
logger
parameter
pubsub
remoteConfig
penyimpanan
tugas
testLab

Variabel

Variabel Deskripsi
app
DEFAULT_FAILURE_POLICY
OPSI_SETELAN_INGRESS Daftar opsi yang tersedia untuk IngressSettings.
MAX_NUMBER_USER_LABEL
MAX_TIMEOUT_SECONDS Nilai waktu tunggu maksimum Cloud Functions.
MIN_TIMEOUT_SECONDS Nilai waktu tunggu min Cloud Functions.
RESET_VALUE Nilai konfigurasi khusus untuk mereset konfigurasi ke default platform.
SUPPORTED_REGIONS Menampilkan daftar semua region yang didukung oleh Cloud Functions.
OPSI_MEMORY_VALID Daftar opsi memori yang tersedia dan didukung oleh Cloud Functions.
OPSI_SETELAN_EGRESS_VPC Daftar opsi yang tersedia untuk VpcConnectorEgressSettings.

config()

Simpan dan ambil data konfigurasi project seperti kunci API pihak ketiga atau setelan lainnya. Anda dapat menetapkan nilai konfigurasi menggunakan Firebase CLI seperti yang dijelaskan di [Konfigurasi Lingkungan](/docs/functions/config-env).

Tanda Tangan:

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

Hasil:

Rekam<string, apa saja>

optionsToEndpoint()

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
opsi DeploymentOptions

Hasil:

ManifesEndpoint

optionsToTrigger()

Tanda Tangan:

export declare function optionsToTrigger(options: DeploymentOptions): any;

Parameter

Parameter Jenis Deskripsi
opsi DeploymentOptions

Hasil:

apa pun

region()

Konfigurasi region tempat fungsi di-deploy.

Tanda Tangan:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parameter

Parameter Jenis Deskripsi
kawasan Array<(typeof SUPPORTED_REGIONS)[angka] | rangkaian | Ekspresi<string> | NilaiReset> Salah satu dari beberapa string wilayah.

Hasil:

FunctionBuilder

Contoh 1

functions.region('us-east1')

Contoh 2

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

runWith()

Konfigurasi opsi runtime untuk fungsi.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
runtimeOptions RuntimeOptions Objek dengan kolom opsional: 1. memory: jumlah memori untuk dialokasikan ke fungsi, nilai yang mungkin adalah: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', dan '8GB'. 2. timeoutSeconds: waktu tunggu untuk fungsi dalam detik, nilai yang mungkin adalah 0 hingga 540. 3. failurePolicy: kebijakan kegagalan fungsi, dengan boolean true yang setara dengan menyediakan objek percobaan ulang kosong. 4. vpcConnector: ID konektor VPC dalam project dan region yang sama. 5. vpcConnectorEgressSettings: saat vpcConnector disetel, kontrol traffic keluar mana yang dikirim melalui vpcConnector. 6. serviceAccount: Akun layanan tertentu untuk fungsi. 7. ingressSettings: setelan traffic masuk untuk fungsi, yang mengontrol tempat fungsi HTTPS dapat dipanggil.Nilai tidak boleh null.

Hasil:

FunctionBuilder

aplikasi

Tanda Tangan:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

KEBIJAKAN_GAGAL_DEFAULT

Tanda Tangan:

DEFAULT_FAILURE_POLICY: FailurePolicy

OPSI SETELAN_INGRESS

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_LABEL

Tanda Tangan:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Nilai waktu tunggu maksimum Cloud Functions.

Tanda Tangan:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Nilai waktu tunggu min Cloud Functions.

Tanda Tangan:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Nilai konfigurasi khusus untuk mereset konfigurasi ke default platform.

Tanda Tangan:

RESET_VALUE: ResetValue

SUPPORTED_REGION

Menampilkan daftar semua region 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"]

OPSI_MEMORY_VALID

Daftar opsi memori yang tersedia dan didukung oleh Cloud Functions.

Tanda Tangan:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

OPSI_SETELAN_EGRESS_VPC

Daftar opsi yang tersedia untuk VpcConnectorEgressSettings.

Tanda Tangan:

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