params namespace

ฟังก์ชัน

ชั้นเรียน

อินเทอร์เฟซ

ตัวแปร

พิมพ์ชื่อแทน

params.defineBoolean()

ประกาศพารามิเตอร์บูลีน

ลายเซ็น:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): 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()

ประกาศพารามิเตอร์ลับที่จะคงค่าใน Secret Manager ของ Cloud เท่านั้น ข้อมูลลับจะจัดเก็บเป็นไบต์สตริงไว้ภายใน ใช้ ParamOptions.as เพื่อให้คำแนะนำประเภทระหว่างการแปลงพารามิเตอร์

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

SecretParam

พารามิเตอร์ที่มีประเภทการแสดงผล string สำหรับ .value

params.defineString()

ประกาศพารามิเตอร์สตริง

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

สตริงพารัม

พารามิเตอร์ที่มีประเภทการแสดงผล string สำหรับ .value

params.multiSelect()

สร้างอินพุตแบบเลือกหลายรายการจากชุดค่า

ลายเซ็น:

export declare function multiSelect(options: string[]): MultiSelectInput;

พารามิเตอร์

การคืนสินค้า:

อินพุตหลายตัวเลือก

params.multiSelect()

สร้างอินพุตแบบเลือกหลายรายการจากแมปป้ายกำกับไปยังค่า

ลายเซ็น:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

พารามิเตอร์

การคืนสินค้า:

อินพุตหลายตัวเลือก

params.select()

สร้างอินพุตที่เลือกจากชุดค่า

ลายเซ็น:

export declare function select<T>(options: T[]): SelectInput<T>;

พารามิเตอร์

การคืนสินค้า:

เลือกอินพุต<T>

params.select()

สร้างอินพุตที่เลือกจากการแมปป้ายกำกับไปยังค่า

ลายเซ็น:

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.gcloudProject

พารามิเตอร์ในตัวที่แก้ไขเป็นรหัสโปรเจ็กต์ที่อยู่ในระบบคลาวด์โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้

ลายเซ็น:

gcloudProject: Param<string>

รหัสโครงการ

พารามิเตอร์ในตัวที่แก้ไขเป็นรหัสโปรเจ็กต์ที่อยู่ในระบบคลาวด์ที่เชื่อมโยงกับโปรเจ็กต์โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้

ลายเซ็น:

projectID: Param<string>

params.storageBucket

พารามิเตอร์ในตัวที่แปลงเป็นที่เก็บข้อมูล Cloud Storage ที่เชื่อมโยงกับฟังก์ชัน โดยไม่ต้องแจ้งผู้ทำให้ใช้งานได้ สตริงว่างหากไม่ได้กำหนด

ลายเซ็น:

storageBucket: Param<string>

params.ParamOptions

ตัวเลือกการกําหนดค่าซึ่งใช้เพื่อปรับแต่งลักษณะการแสดงข้อความแจ้งของพารามิเตอร์ได้

ลายเซ็น:

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