פונקציות
| פוּנקצִיָה | תיאור |
|---|---|
| defineBoolean(שם, אפשרויות) | הכריז על פראם בוליאני. |
| defineInt(שם, אפשרויות) | הכריז על פראם של מספר שלם. |
| defineList(שם, אפשרויות) | הכריז על פרמטר רשימה. |
| defineSecret(שם) | מצהיר על פראם סודי, שימשיך ערכים רק ב-Cloud Secret Manager. סודות מאוחסנים באופן פנימי כ-bytestrings. השתמש ב- ParamOptions. as לספק רמז לסוג במהלך רזולוציית פרמטר. |
| defineString(שם, אפשרויות) | הכריז על פראם של מחרוזת. |
שיעורים
| מעמד | תיאור |
|---|---|
| ביטוי |
משתנים
| מִשְׁתַנֶה | תיאור |
|---|---|
| כתובת אתר של מסד נתונים | פרמטר מובנה הפותר את ברירת המחדל של כתובת ה-URL של מסד הנתונים של RTDB המשויכת לפרויקט, מבלי לבקש מהפריסה. מחרוזת ריקה אם לא קיימת. |
| הכריז על פארמס | |
| gcloudProject | פרמטר מובנה שפותר את מזהה הפרויקט של הענן, מבלי לבקש מהפריס. |
| מזהה פרויקט | פרמטר מובנה שפותר את מזהה הפרויקט בענן המשויך לפרויקט, מבלי לבקש מהפרוס. |
| דלי אחסון | פרמטר מובנה שפותר את דלי האחסון בענן המשויך לפונקציה, מבלי לבקש מהפריס. מחרוזת ריקה אם לא מוגדרת. |
הקלד כינויים
| הקלד כינוי | תיאור |
|---|---|
| ParamOptions | אפשרויות תצורה שבהן ניתן להשתמש כדי להתאים אישית את התנהגות הנחיה של Param. |
params.defineBoolean()
הכריז על פראם בוליאני.
חֲתִימָה:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם משתנה הסביבה שבו יש להשתמש כדי לטעון את הפראם. |
| אפשרויות | ParamOptions <בוליאנית> | אפשרויות תצורה עבור הפראם. |
החזרות:
BooleanParam
פראם עם סוג החזרה boolean עבור .value .
params.defineInt()
הכריז על פראם של מספר שלם.
חֲתִימָה:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם משתנה הסביבה שבו יש להשתמש כדי לטעון את הפראם. |
| אפשרויות | ParamOptions <מספר> | אפשרויות תצורה עבור הפראם. |
החזרות:
IntParam
פראם עם סוג החזרת number עבור .value .
params.defineList()
הכריז על פרמטר רשימה.
חֲתִימָה:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם משתנה הסביבה שבו יש להשתמש כדי לטעון את הפראם. |
| אפשרויות | ParamOptions <string[]> | אפשרויות תצורה עבור הפראם. |
החזרות:
ListParam
פראם עם סוג החזרה מחרוזת string[] עבור .value .
params.defineSecret()
מצהיר על פראם סודי, שימשיך ערכים רק ב-Cloud Secret Manager. סודות מאוחסנים באופן פנימי כ-bytestrings. השתמש ב- ParamOptions. as לספק רמז לסוג במהלך רזולוציית פרמטר.
חֲתִימָה:
export declare function defineSecret(name: string): SecretParam;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם משתנה הסביבה שבו יש להשתמש כדי לטעון את הפראם. |
החזרות:
SecretParam
פראם עם סוג החזרת string עבור .value .
params.defineString()
הכריז על פראם של מחרוזת.
חֲתִימָה:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם משתנה הסביבה שבו יש להשתמש כדי לטעון את הפראם. |
| אפשרויות | ParamOptions <string> | אפשרויות תצורה עבור הפראם. |
החזרות:
StringParam
פראם עם סוג החזרת string עבור .value .
params.databaseURL
פרמטר מובנה הפותר את ברירת המחדל של כתובת ה-URL של מסד הנתונים של RTDB המשויכת לפרויקט, מבלי לבקש מהפריסה. מחרוזת ריקה אם לא קיימת.
חֲתִימָה:
databaseURL: Param<string>
params.declaredParams
חֲתִימָה:
declaredParams: SecretOrExpr[]
params.gcloudProject
פרמטר מובנה שפותר את מזהה הפרויקט של הענן, מבלי לבקש מהפריס.
חֲתִימָה:
gcloudProject: Param<string>
params.projectID
פרמטר מובנה שפותר את מזהה הפרויקט בענן המשויך לפרויקט, מבלי לבקש מהפרוס.
חֲתִימָה:
projectID: Param<string>
params.storageBucket
פרמטר מובנה שפותר את דלי האחסון בענן המשויך לפונקציה, מבלי לבקש מהפריס. מחרוזת ריקה אם לא מוגדרת.
חֲתִימָה:
storageBucket: Param<string>
params.ParamOptions
אפשרויות תצורה שבהן ניתן להשתמש כדי להתאים אישית את התנהגות הנחיה של Param.
חֲתִימָה:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;