params namespace

ฟังก์ชั่น

ชั้นเรียน

อินเทอร์เฟซ

ตัวแปร

พิมพ์นามแฝง

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;

พารามิเตอร์

ผลตอบแทน:

MultiSelectInput

params.multiSelect()

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

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

MultiSelectInput

params.เลือก()

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

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

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

params.เลือก()

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

ลายเซ็น:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<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">;