ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
กำหนดบูลีน(ชื่อ, ตัวเลือก) | ประกาศพารามิเตอร์บูลีน |
DefinInt(ชื่อ, ตัวเลือก) | ประกาศพารามิเตอร์จำนวนเต็ม |
DefinList(ชื่อ, ตัวเลือก) | ประกาศพารามิเตอร์รายการ |
DefenceSecret(ชื่อ) | ประกาศพารามิเตอร์ลับที่จะคงค่าไว้ใน Cloud Secret Manager เท่านั้น ข้อมูลลับจะถูกเก็บไว้ภายในเป็นไบต์ ใช้ ParamOptions.as เพื่อระบุประเภทคำใบ้ระหว่างการแก้ไขพารามิเตอร์ |
DefineString(ชื่อ ตัวเลือก) | ประกาศพารามิเตอร์สตริง |
เลือกหลายรายการ (ตัวเลือก) | สร้างอินพุตแบบเลือกหลายรายการจากชุดค่า |
เลือกหลายรายการ (ตัวเลือก) | สร้างอินพุตแบบเลือกหลายรายการตั้งแต่แผนผังป้ายกำกับไปจนถึงค่า |
เลือก(ตัวเลือก) | สร้างอินพุตที่เลือกจากชุดค่า |
เลือก(optionsWithLabels) | สร้างอินพุตแบบเลือกจากแผนผังป้ายกำกับไปจนถึงค่า |
ชั้นเรียน
ระดับ | คำอธิบาย |
---|---|
การแสดงออก |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
MultiSelectInput | ระบุว่าควรกำหนดค่าของพารามิเตอร์โดยให้ผู้ใช้เลือกเซ็ตย่อยจากรายการตัวเลือกที่เตรียมไว้ล่วงหน้าแบบโต้ตอบ ณ เวลาปรับใช้ จะส่งผลให้เกิดข้อผิดพลาดหากใช้กับพารามิเตอร์ประเภทอื่นที่ไม่ใช่ string[] |
เลือกอินพุต | ระบุว่าควรกำหนดค่าของพารามิเตอร์โดยให้ผู้ใช้เลือกจากรายการตัวเลือกที่เตรียมไว้ล่วงหน้าแบบโต้ตอบ ณ เวลาปรับใช้ |
เลือก ตัวเลือก | หนึ่งในตัวเลือกที่มีให้กับ SelectInput ซึ่งประกอบด้วยค่าและป้ายกำกับที่มนุษย์สามารถอ่านได้ (เป็นทางเลือก) เพื่อแสดงในส่วนต่อประสานการเลือก |
การป้อนข้อความ | ระบุว่าควรกำหนดค่าของพารามิเตอร์โดยพร้อมท์ให้ผู้ใช้พิมพ์แบบโต้ตอบในเวลาปรับใช้ อินพุตที่ไม่ตรงกับ validationRegex ที่ระบุ (หากมี) จะถูกลองอีกครั้ง |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
BUCKET_PICKER | สร้างรายการบัคเก็ตในโปรเจ็กต์โดยอัตโนมัติซึ่งผู้ใช้สามารถเลือกได้ |
URL ฐานข้อมูล | พารามิเตอร์ในตัวที่แก้ไขเป็น URL ฐานข้อมูล RTDB เริ่มต้นที่เกี่ยวข้องกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่มีอยู่ |
ประกาศพารามิเตอร์ | |
gcloudProject | พารามิเตอร์ในตัวที่แปลงเป็นรหัสโปรเจ็กต์ระบบคลาวด์ โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้ |
รหัสโครงการ | พารามิเตอร์ในตัวที่แก้ไขเป็นรหัสโปรเจ็กต์ระบบคลาวด์ที่เชื่อมโยงกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้ |
ที่เก็บข้อมูลBucket | พารามิเตอร์บิวท์อินที่แก้ไขเป็นบัคเก็ตของพื้นที่เก็บข้อมูลบนคลาวด์ที่เชื่อมโยงกับฟังก์ชัน โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่ได้กำหนดไว้ |
พิมพ์นามแฝง
พิมพ์นามแฝง | คำอธิบาย |
---|---|
ตัวเลือกพารามิเตอร์ | ตัวเลือกการกำหนดค่าที่สามารถใช้เพื่อปรับแต่งพฤติกรรมการแจ้งของพารามิเตอร์ |
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.multiSelect()
สร้างอินพุตแบบเลือกหลายรายการจากชุดค่า
ลายเซ็น:
export declare function multiSelect(options: string[]): MultiSelectInput;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือก | สตริง[] |
ผลตอบแทน:
params.multiSelect()
สร้างอินพุตแบบเลือกหลายรายการตั้งแต่แผนผังป้ายกำกับไปจนถึงค่า
ลายเซ็น:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือก | บันทึก<string, string> |
ผลตอบแทน:
params.เลือก()
สร้างอินพุตที่เลือกจากชุดค่า
ลายเซ็น:
export declare function select<T>(options: T[]): SelectInput<T>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือก | ที[] |
ผลตอบแทน:
เลือกอินพุต <ท>
params.เลือก()
สร้างอินพุตแบบเลือกจากแผนผังป้ายกำกับไปจนถึงค่า
ลายเซ็น:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือกด้วยป้ายกำกับ | บันทึก<สตริง, T> |
ผลตอบแทน:
เลือกอินพุต <ท>
params.BUCKET_PICKER
สร้างรายการบัคเก็ตในโปรเจ็กต์โดยอัตโนมัติซึ่งผู้ใช้สามารถเลือกได้
ลายเซ็น:
BUCKET_PICKER: ResourceInput
params.databaseURL
พารามิเตอร์ในตัวที่แก้ไขเป็น URL ฐานข้อมูล RTDB เริ่มต้นที่เกี่ยวข้องกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่มีอยู่
ลายเซ็น:
databaseURL: Param<string>
params.declaredParams
ลายเซ็น:
declaredParams: SecretOrExpr[]
params.gcloudโปรเจ็กต์
พารามิเตอร์ในตัวที่แปลงเป็นรหัสโปรเจ็กต์ระบบคลาวด์ โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้
ลายเซ็น:
gcloudProject: Param<string>
params.projectID
พารามิเตอร์ในตัวที่แก้ไขเป็นรหัสโปรเจ็กต์ระบบคลาวด์ที่เชื่อมโยงกับโปรเจ็กต์ โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้
ลายเซ็น:
projectID: Param<string>
params.storageBucket
พารามิเตอร์บิวท์อินที่แก้ไขเป็นบัคเก็ตของพื้นที่เก็บข้อมูลบนคลาวด์ที่เชื่อมโยงกับฟังก์ชัน โดยไม่ต้องแจ้งผู้ปรับใช้ สตริงว่างหากไม่ได้กำหนดไว้
ลายเซ็น:
storageBucket: Param<string>
params.ParamOptions
ตัวเลือกการกำหนดค่าที่สามารถใช้เพื่อปรับแต่งพฤติกรรมการแจ้งของพารามิเตอร์
ลายเซ็น:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;