Fungsi
| Fungsi | Keterangan |
|---|---|
| definisikanBoolean(nama, opsi) | Deklarasikan param boolean. |
| definisikanInt(nama, opsi) | Deklarasikan parameter integer. |
| defineList(nama, opsi) | Deklarasikan parameter daftar. |
| definisikanRahasia(nama) | Mendeklarasikan parameter rahasia, yang hanya akan mempertahankan nilai di Cloud Secret Manager. Rahasia disimpan secara internal sebagai bytestring. Gunakan ParamOptions. as memberikan petunjuk tipe selama resolusi parameter. |
| definisikanString(nama, opsi) | Deklarasikan parameter string. |
Kelas
| Kelas | Keterangan |
|---|---|
| Ekspresi |
Variabel
| Variabel | Keterangan |
|---|---|
| URL basis data | Parameter bawaan yang menentukan URL database RTDB default yang terkait dengan proyek, tanpa meminta penyebar. String kosong jika tidak ada. |
| dinyatakanParams | |
| gcloudProject | Parameter bawaan yang menyelesaikan ID proyek Cloud, tanpa meminta penyebar. |
| ID proyek | Parameter bawaan yang menentukan ID proyek Cloud yang terkait dengan proyek, tanpa meminta penyebar. |
| penyimpananBucket | Parameter bawaan yang menyelesaikan bucket penyimpanan Cloud yang terkait dengan fungsi tersebut, tanpa meminta penyebar. String kosong jika tidak ditentukan. |
Ketik Alias
| Ketik Alias | Keterangan |
|---|---|
| Opsi Param | Opsi konfigurasi yang dapat digunakan untuk menyesuaikan perilaku permintaan Param. |
params.defineBoolean()
Deklarasikan param boolean.
Tanda tangan:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| nama | rangkaian | Nama variabel lingkungan yang digunakan untuk memuat param. |
| pilihan | Opsi Param <boolean> | Opsi konfigurasi untuk param. |
Pengembalian:
BooleanParam
Param dengan tipe pengembalian boolean untuk .value .
params.defineInt()
Deklarasikan parameter integer.
Tanda tangan:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| nama | rangkaian | Nama variabel lingkungan yang digunakan untuk memuat param. |
| pilihan | Opsi Param <angka> | Opsi konfigurasi untuk param. |
Pengembalian:
IntParam
Param dengan tipe pengembalian number untuk .value .
params.defineList()
Deklarasikan parameter daftar.
Tanda tangan:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| nama | rangkaian | Nama variabel lingkungan yang digunakan untuk memuat param. |
| pilihan | Opsi Param <string[]> | Opsi konfigurasi untuk param. |
Pengembalian:
DaftarParam
Param dengan tipe pengembalian string[] untuk .value .
params.defineSecret()
Mendeklarasikan parameter rahasia, yang hanya akan mempertahankan nilai di Cloud Secret Manager. Rahasia disimpan secara internal sebagai bytestring. Gunakan ParamOptions. as memberikan petunjuk tipe selama resolusi parameter.
Tanda tangan:
export declare function defineSecret(name: string): SecretParam;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| nama | rangkaian | Nama variabel lingkungan yang digunakan untuk memuat param. |
Pengembalian:
RahasiaParam
Param dengan tipe pengembalian string untuk .value .
params.defineString()
Deklarasikan parameter string.
Tanda tangan:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| nama | rangkaian | Nama variabel lingkungan yang digunakan untuk memuat param. |
| pilihan | Opsi Param <string> | Opsi konfigurasi untuk param. |
Pengembalian:
StringParam
Param dengan tipe pengembalian string untuk .value .
params.databaseURL
Parameter bawaan yang menentukan URL database RTDB default yang terkait dengan proyek, tanpa meminta penyebar. String kosong jika tidak ada.
Tanda tangan:
databaseURL: Param<string>
params.declaredParams
Tanda tangan:
declaredParams: SecretOrExpr[]
params.gcloudProject
Parameter bawaan yang menyelesaikan ID proyek Cloud, tanpa meminta penyebar.
Tanda tangan:
gcloudProject: Param<string>
params.projectID
Parameter bawaan yang menentukan ID proyek Cloud yang terkait dengan proyek, tanpa meminta penyebar.
Tanda tangan:
projectID: Param<string>
params.storageBucket
Parameter bawaan yang menyelesaikan bucket penyimpanan Cloud yang terkait dengan fungsi tersebut, tanpa meminta penyebar. String kosong jika tidak ditentukan.
Tanda tangan:
storageBucket: Param<string>
params.ParamOptions
Opsi konfigurasi yang dapat digunakan untuk menyesuaikan perilaku permintaan Param.
Tanda tangan:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;