ฟังก์ชั่น
| การทำงาน | คำอธิบาย |
|---|---|
| กำหนดบูลีน(ชื่อ ตัวเลือก) | ประกาศพารามิเตอร์บูลีน |
| DefinInt(ชื่อ, ตัวเลือก) | ประกาศพารามิเตอร์จำนวนเต็ม |
| DefinList(ชื่อ, ตัวเลือก) | ประกาศพารามิเตอร์รายการ |
| DefenceSecret(ชื่อ) | ประกาศพารามิเตอร์ลับที่จะคงค่าไว้ใน Cloud Secret Manager เท่านั้น ข้อมูลลับจะถูกจัดเก็บไว้ภายในเป็นสตริงไบต์ ใช้ ParamOptions as ให้คำใบ้ประเภทระหว่างการแก้ไขพารามิเตอร์ |
| DefineString(ชื่อ ตัวเลือก) | ประกาศพารามิเตอร์สตริง |
ชั้นเรียน
| ระดับ | คำอธิบาย |
|---|---|
| การแสดงออก |
ตัวแปร
| ตัวแปร | คำอธิบาย |
|---|---|
| URL ฐานข้อมูล | พารามิเตอร์บิวท์อินที่แก้ไขเป็น URL ฐานข้อมูล RTDB เริ่มต้นที่เกี่ยวข้องกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่มีอยู่ |
| ประกาศพารามิเตอร์ | |
| gcloudProject | พารามิเตอร์บิวท์อินที่แก้ไขเป็นรหัสโปรเจ็กต์ Cloud โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้ |
| รหัสโครงการ | พารามิเตอร์บิวท์อินที่แก้ไขเป็นรหัสโปรเจ็กต์ระบบคลาวด์ที่เชื่อมโยงกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้ |
| ที่เก็บข้อมูลBucket | พารามิเตอร์บิวท์อินที่แก้ไขเป็นที่เก็บข้อมูล Cloud ที่เชื่อมโยงกับฟังก์ชัน โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่ได้กำหนดไว้ |
พิมพ์นามแฝง
| พิมพ์นามแฝง | คำอธิบาย |
|---|---|
| ตัวเลือกพารามิเตอร์ | ตัวเลือกการกำหนดค่าที่สามารถใช้เพื่อปรับแต่งพฤติกรรมการแจ้งของพารามิเตอร์ |
params.defineBoolean()
ประกาศพารามิเตอร์บูลีน
ลายเซ็น:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ชื่อ | เชือก | ชื่อของตัวแปรสภาพแวดล้อมที่จะใช้ในการโหลดพารามิเตอร์ |
| ตัวเลือก | ตัวเลือกพารามิเตอร์ <บูลีน> | ตัวเลือกการกำหนดค่าสำหรับพารามิเตอร์ |
ผลตอบแทน:
BooleanParam
พารามิเตอร์ที่มีประเภทส่งคืน boolean สำหรับ .value .
params.defineInt()
ประกาศพารามิเตอร์จำนวนเต็ม
ลายเซ็น:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ชื่อ | เชือก | ชื่อของตัวแปรสภาพแวดล้อมที่จะใช้ในการโหลดพารามิเตอร์ |
| ตัวเลือก | ตัวเลือกพารามิเตอร์ <จำนวน> | ตัวเลือกการกำหนดค่าสำหรับพารามิเตอร์ |
ผลตอบแทน:
IntParam
พารามิเตอร์ที่มีประเภทส่งคืน number สำหรับ .value .
params.defineList()
ประกาศพารามิเตอร์รายการ
ลายเซ็น:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ชื่อ | เชือก | ชื่อของตัวแปรสภาพแวดล้อมที่จะใช้ในการโหลดพารามิเตอร์ |
| ตัวเลือก | ตัวเลือกพารามิเตอร์ <สตริง[]> | ตัวเลือกการกำหนดค่าสำหรับพารามิเตอร์ |
ผลตอบแทน:
รายการพารามิเตอร์
พารามิเตอร์ที่มีชนิดส่งคืน string[] สำหรับ .value .
params.defineSecret()
ประกาศพารามิเตอร์ลับที่จะคงค่าไว้ใน Cloud Secret Manager เท่านั้น ข้อมูลลับจะถูกจัดเก็บไว้ภายในเป็นสตริงไบต์ ใช้ ParamOptions as ให้คำใบ้ประเภทระหว่างการแก้ไขพารามิเตอร์
ลายเซ็น:
export declare function defineSecret(name: string): SecretParam;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ชื่อ | เชือก | ชื่อของตัวแปรสภาพแวดล้อมที่จะใช้ในการโหลดพารามิเตอร์ |
ผลตอบแทน:
SecretParam
พารามิเตอร์ที่มีชนิดส่งคืน string สำหรับ .value .
params.defineString()
ประกาศพารามิเตอร์สตริง
ลายเซ็น:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ชื่อ | เชือก | ชื่อของตัวแปรสภาพแวดล้อมที่จะใช้ในการโหลดพารามิเตอร์ |
| ตัวเลือก | ตัวเลือกพารามิเตอร์ <สตริง> | ตัวเลือกการกำหนดค่าสำหรับพารามิเตอร์ |
ผลตอบแทน:
StringParam
พารามิเตอร์ที่มีชนิดส่งคืน string สำหรับ .value .
params.databaseURL
พารามิเตอร์บิวท์อินที่แก้ไขเป็น URL ฐานข้อมูล RTDB เริ่มต้นที่เกี่ยวข้องกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่มีอยู่
ลายเซ็น:
databaseURL: Param<string>
params.declaredParams
ลายเซ็น:
declaredParams: SecretOrExpr[]
params.gcloudโปรเจ็กต์
พารามิเตอร์บิวท์อินที่แก้ไขเป็นรหัสโปรเจ็กต์ Cloud โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้
ลายเซ็น:
gcloudProject: Param<string>
params.projectID
พารามิเตอร์บิวท์อินที่แก้ไขเป็นรหัสโปรเจ็กต์ระบบคลาวด์ที่เชื่อมโยงกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้
ลายเซ็น:
projectID: Param<string>
params.storageBucket
พารามิเตอร์บิวท์อินที่แก้ไขเป็นที่เก็บข้อมูล Cloud ที่เชื่อมโยงกับฟังก์ชัน โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่ได้กำหนดไว้
ลายเซ็น:
storageBucket: Param<string>
params.ParamOptions
ตัวเลือกการกำหนดค่าที่สามารถใช้เพื่อปรับแต่งพฤติกรรมการแจ้งของพารามิเตอร์
ลายเซ็น:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;