İşlevler
İşlev | Açıklama |
---|---|
defineBoole(ad; seçenekler) | Boole parametresi tanımlayın. |
defineInt(ad, seçenekler) | Tam sayı parametresi tanımlama. |
defineList(ad; seçenekler) | Bir liste parametresi bildir. |
defineSecret(ad) | Yalnızca Cloud Secret Manager'daki değerleri koruyacak bir gizli parametre tanımlar. Gizli anahtarlar bayt dizeleri olarak bir arada depolanır. Parametre çözünürlüğü sırasında tür ipucu sağlamak için ParamOptions.as öğesini kullanın. |
defineString(ad; seçenekler) | Dize parametresi tanımlayın. |
Sınıflar
Sınıf | Açıklama |
---|---|
İfade |
Değişkenler
Değişken | Açıklama |
---|---|
veritabanıURL'si | Dağıtıcıya sormadan projeyle ilişkili varsayılan RTDB veritabanı URL'sine çözümlenen yerleşik bir parametre. Yoksa boş dize. |
declaredParams | |
gcloudProject | Dağıtıcıya sormadan Cloud projesi kimliğine çözümlenen yerleşik bir parametre. |
proje kimliği | Projeyle ilişkili Cloud projesi kimliğine çözümlenen, dağıtıcıya sormadan çözümlenen yerleşik parametre. |
storageBucket | Dağıtıcıya sormadan işlevle ilişkili Cloud Storage paketine çözümlenen yerleşik parametre. Tanımlanmamışsa boş dize. |
Tür Takma Adları
Takma Ad yazın | Açıklama |
---|---|
ParamSeçenekleri | Bir parametrenin istem davranışını özelleştirmek için kullanılabilecek yapılandırma seçenekleri. |
params.defineBoole()
Boole parametresi tanımlayın.
İmza:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
ad | dize | Parametreyi yüklemek için kullanılacak ortam değişkeninin adı. |
seçenekler | ParamOptions<boole> | Parametreye ilişkin yapılandırma seçenekleri. |
Şunu döndürür:
BooleParam
.value
için boolean
dönüş türüne sahip bir Parametre.
params.defineInt()
Tam sayı parametresi tanımlama.
İmza:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
ad | dize | Parametreyi yüklemek için kullanılacak ortam değişkeninin adı. |
seçenekler | ParamOptions<sayı> | Parametreye ilişkin yapılandırma seçenekleri. |
Şunu döndürür:
IntParam
.value
için number
dönüş türüne sahip bir Parametre.
params.defineList()
Bir liste parametresi bildir.
İmza:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
ad | dize | Parametreyi yüklemek için kullanılacak ortam değişkeninin adı. |
seçenekler | ParamOptions<dize[]> | Parametreye ilişkin yapılandırma seçenekleri. |
Şunu döndürür:
ListParam
.value
için string[]
dönüş türüne sahip bir Parametre.
params.defineSecret()
Yalnızca Cloud Secret Manager'daki değerleri koruyacak bir gizli parametre tanımlar. Gizli anahtarlar bayt dizeleri olarak bir arada depolanır. Parametre çözünürlüğü sırasında tür ipucu sağlamak için ParamOptions.as
öğesini kullanın.
İmza:
export declare function defineSecret(name: string): SecretParam;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
ad | dize | Parametreyi yüklemek için kullanılacak ortam değişkeninin adı. |
Şunu döndürür:
Gizli Param
.value
için string
dönüş türüne sahip bir Parametre.
params.defineString()
Dize parametresi tanımlayın.
İmza:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
ad | dize | Parametreyi yüklemek için kullanılacak ortam değişkeninin adı. |
seçenekler | ParamOptions<dize> | Parametreye ilişkin yapılandırma seçenekleri. |
Şunu döndürür:
StringParam
.value
için string
dönüş türüne sahip bir Parametre.
params.veritabanıURL'si
Dağıtıcıya sormadan projeyle ilişkili varsayılan RTDB veritabanı URL'sine çözümlenen yerleşik bir parametre. Yoksa boş dize.
İmza:
databaseURL: Param<string>
params.declaredParams
İmza:
declaredParams: SecretOrExpr[]
params.gcloudProject
Dağıtıcıya sormadan Cloud projesi kimliğine çözümlenen yerleşik bir parametre.
İmza:
gcloudProject: Param<string>
parametre.projekimliği
Projeyle ilişkili Cloud projesi kimliğine çözümlenen, dağıtıcıya sormadan çözümlenen yerleşik parametre.
İmza:
projectID: Param<string>
params.storageBucket
Dağıtıcıya sormadan işlevle ilişkili Cloud Storage paketine çözümlenen yerleşik parametre. Tanımlanmamışsa boş dize.
İmza:
storageBucket: Param<string>
params.ParamOptions
Bir parametrenin istem davranışını özelleştirmek için kullanılabilecek yapılandırma seçenekleri.
İmza:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;