params namespace

Functions

Fungsi Deskripsi
defineBoolean(nama, opsi) Mendeklarasikan parameter boolean.
defineInt(nama, opsi) Mendeklarasikan parameter bilangan bulat.
defineList(nama, opsi) Mendeklarasikan parameter daftar.
defineSecret(nama) Mendeklarasikan parameter secret, yang hanya akan mempertahankan nilai di Cloud Secret Manager. Secret disimpan secara interal sebagai bytestring. Gunakan ParamOptions.as untuk memberikan petunjuk jenis selama resolusi parameter.
defineString(nama, opsi) Mendeklarasikan parameter string.

Kelas

Class Deskripsi
Ekspresi

Variabel

Variabel Deskripsi
databaseURL Parameter bawaan yang me-resolve ke URL database RTDB default yang terkait dengan project, tanpa meminta izin dari deploymenter. String kosong jika tidak ada.
DeclaredParams
gcloudProject Parameter bawaan yang me-resolve ke project ID Cloud, tanpa meminta izin deploymenter.
projectID Parameter bawaan yang me-resolve ke project ID Cloud yang terkait dengan project, tanpa meminta deploymenter.
storageBucket Parameter bawaan yang me-resolve ke bucket Cloud Storage yang terkait dengan fungsi tersebut, tanpa meminta deploymenter. String kosong jika tidak ditentukan.

Ketik Alias

Ketik Alias Deskripsi
ParamOptions Opsi konfigurasi yang dapat digunakan untuk menyesuaikan perilaku prompting Param.

params.defineBoolean()

Deklarasikan parameter boolean.

Tanda Tangan:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<boolean> Opsi konfigurasi untuk parameter.

Hasil:

BooleanParam

Parameter dengan jenis nilai yang ditampilkan boolean untuk .value.

params.defineInt()

Mendeklarasikan parameter bilangan bulat.

Tanda Tangan:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<number> Opsi konfigurasi untuk parameter.

Hasil:

IntParam

Parameter dengan jenis nilai yang ditampilkan number untuk .value.

{i>params.defineList()<i}

Mendeklarasikan parameter daftar.

Tanda Tangan:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<string[]> Opsi konfigurasi untuk parameter.

Hasil:

{i>ListParam<i}

Parameter dengan jenis nilai yang ditampilkan string[] untuk .value.

params.defineSecret()

Mendeklarasikan parameter secret, yang hanya akan mempertahankan nilai di Cloud Secret Manager. Secret disimpan secara interal sebagai bytestring. Gunakan ParamOptions.as untuk memberikan petunjuk jenis selama resolusi parameter.

Tanda Tangan:

export declare function defineSecret(name: string): SecretParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.

Hasil:

{i>SecretParam<i}

Parameter dengan jenis nilai yang ditampilkan string untuk .value.

{i>params.defineString()<i}

Mendeklarasikan parameter string.

Tanda Tangan:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

Parameter

Parameter Jenis Deskripsi
name string Nama variabel lingkungan yang akan digunakan untuk memuat parameter.
opsi ParamOptions<string> Opsi konfigurasi untuk parameter.

Hasil:

StringParam

Parameter dengan jenis nilai yang ditampilkan string untuk .value.

params.databaseURL

Parameter bawaan yang me-resolve ke URL database RTDB default yang terkait dengan project, tanpa meminta izin dari deploymenter. String kosong jika tidak ada.

Tanda Tangan:

databaseURL: Param<string>

params.DeclaredParams

Tanda Tangan:

declaredParams: SecretOrExpr[]

params.gcloudProject

Parameter bawaan yang me-resolve ke project ID Cloud, tanpa meminta izin deploymenter.

Tanda Tangan:

gcloudProject: Param<string>

params.projectID

Parameter bawaan yang me-resolve ke project ID Cloud yang terkait dengan project, tanpa meminta deploymenter.

Tanda Tangan:

projectID: Param<string>

params.storageBucket

Parameter bawaan yang me-resolve ke bucket Cloud Storage yang terkait dengan fungsi tersebut, tanpa meminta deploymenter. String kosong jika tidak ditentukan.

Tanda Tangan:

storageBucket: Param<string>

params.ParamOptions

Opsi konfigurasi yang dapat digunakan untuk menyesuaikan perilaku prompting Param.

Tanda Tangan:

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