params namespace

Fungsi

Fungsi Keterangan
definisikanBoolean(nama, opsi) Deklarasikan parameter boolean.
definisikanInt(nama, opsi) Deklarasikan parameter bilangan bulat.
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 untuk memberikan petunjuk tipe selama resolusi parameter.
definisikanString(nama, opsi) Deklarasikan parameter string.
multiPilih (opsi) Buat input multi-pilih dari serangkaian nilai.
multiPilih (opsi) Buat masukan multi-pilihan dari peta label ke nilai.
Pilih Pilihan) Buat input pilihan dari serangkaian nilai.
pilih(opsiDenganLabel) Buat masukan pilihan dari peta label ke nilai.

Kelas

Kelas Keterangan
Ekspresi

Antarmuka

Antarmuka Keterangan
Input MultiPilih Menentukan bahwa nilai parameter harus ditentukan dengan meminta pengguna memilih subset dari daftar opsi yang telah disimpan sebelumnya secara interaktif pada waktu penerapan. Akan menghasilkan kesalahan jika digunakan pada parameter bertipe selain string[] .
PilihMasukan Menentukan bahwa nilai parameter harus ditentukan dengan meminta pengguna memilih dari daftar opsi yang telah disiapkan sebelumnya secara interaktif pada waktu penerapan.
Pilih Pilihan Salah satu opsi yang disediakan untuk SelectInput , berisi nilai dan secara opsional label yang dapat dibaca manusia untuk ditampilkan di antarmuka pemilihan.
Masukan Teks Menentukan bahwa nilai parameter harus ditentukan dengan meminta pengguna mengetikkannya secara interaktif pada waktu penerapan. Input yang tidak cocok dengan validationRegex yang diberikan, jika ada, akan dicoba ulang.

Variabel

Variabel Keterangan
BUCKET_PICKER Buat otomatis daftar keranjang dalam proyek yang dapat dipilih pengguna.
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 ditetapkan ke 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 suatu parameter.

params.defineBoolean()

Deklarasikan parameter 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 parameter.
pilihan Opsi Param <boolean> Opsi konfigurasi untuk parameter.

Pengembalian:

BooleanParam

Parameter dengan tipe pengembalian boolean untuk .value .

params.defineInt()

Deklarasikan parameter bilangan bulat.

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 parameter.
pilihan Opsi Param <angka> Opsi konfigurasi untuk parameter.

Pengembalian:

IntParam

Parameter 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 parameter.
pilihan Opsi Param <string[]> Opsi konfigurasi untuk parameter.

Pengembalian:

DaftarParam

Parameter 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 untuk 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 parameter.

Pengembalian:

RahasiaParam

Parameter 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 parameter.
pilihan Opsi Param <string> Opsi konfigurasi untuk parameter.

Pengembalian:

StringParam

Parameter dengan tipe pengembalian string untuk .value .

params.multiPilih()

Buat input multi-pilih dari serangkaian nilai.

Tanda tangan:

export declare function multiSelect(options: string[]): MultiSelectInput;

Parameter

Parameter Jenis Keterangan
pilihan rangkaian[]

Pengembalian:

Input MultiPilih

params.multiPilih()

Buat masukan multi-pilihan dari peta label ke nilai.

Tanda tangan:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

Parameter

Parameter Jenis Keterangan
pilihan Rekam<string, string>

Pengembalian:

Input MultiPilih

params.pilih()

Buat input pilihan dari serangkaian nilai.

Tanda tangan:

export declare function select<T>(options: T[]): SelectInput<T>;

Parameter

Parameter Jenis Keterangan
pilihan T[]

Pengembalian:

PilihMasukan <T>

params.pilih()

Buat masukan pilihan dari peta label ke nilai.

Tanda tangan:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

Parameter

Parameter Jenis Keterangan
pilihanDenganLabels Rekam<string, T>

Pengembalian:

PilihMasukan <T>

params.BUCKET_PICKER

Buat otomatis daftar keranjang dalam proyek yang dapat dipilih pengguna.

Tanda tangan:

BUCKET_PICKER: ResourceInput

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 ditetapkan ke 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 suatu parameter.

Tanda tangan:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;