params namespace

Hàm

Chức năng	Mô tả
xác địnhBoolean(tên, tuỳ chọn)	Khai báo tham số boolean.
địnhInt(tên; tuỳ chọn)	Khai báo một tham số số nguyên.
defineList(tên, tuỳ chọn)	Khai báo tham số danh sách.
defineSecret(name)	Khai báo một tham số bí mật. Tham số này sẽ chỉ lưu giữ các giá trị trong Trình quản lý bí mật trên đám mây. Khoá bí mật được lưu trữ nội bộ dưới dạng bytestring. Sử dụng ParamOptions.as để cung cấp gợi ý loại trong quá trình phân giải tham số.
defineString(name, options)	Khai báo một tham số chuỗi.
multiSelect(options)	Tạo dữ liệu đầu vào để chọn nhiều giá trị từ một chuỗi giá trị.
multiSelect(options)	Tạo dữ liệu đầu vào có nhiều lựa chọn từ sơ đồ liên kết nhãn đến giá trị.
select(options)	Tạo một giá trị đầu vào chọn lọc trong một chuỗi các giá trị.
select(optionsWithlabels)	Tạo mục nhập lựa chọn từ sơ đồ liên kết nhãn đến giá trị.

Lớp học

Hạng	Mô tả
Biểu thức

Giao diện

Giao diện	Mô tả
MultiSelectInput	Chỉ định rằng giá trị của thông số phải được xác định bằng cách để người dùng chọn một tập hợp con trong danh sách các tuỳ chọn được soạn trước theo cách có tính tương tác tại thời điểm triển khai. Sẽ dẫn đến lỗi nếu được sử dụng trên các tham số thuộc loại không phải string[].
SelectInput	Chỉ định rằng giá trị của thông số phải được xác định bằng cách cho phép người dùng chọn từ danh sách các tùy chọn được soạn trước theo cách tương tác tại thời điểm triển khai.
SelectOptions (Chọn tuỳ chọn)	Một trong các tuỳ chọn được cung cấp cho SelectInput, chứa giá trị và tuỳ ý là nhãn mà con người có thể đọc được để hiện trong giao diện chọn.
TextInput	Chỉ định giá trị của một thông số cần được xác định bằng cách nhắc người dùng nhập giá trị đó theo cách có tính tương tác tại thời điểm triển khai. Hệ thống sẽ thử lại nếu thông tin đầu vào không khớp với hàm verificationRegex đã cung cấp (nếu có).

Biến

Biến	Mô tả
BUCKET_PICKER	Tự động tạo danh sách nhóm trong một dự án mà người dùng có thể chọn.
databaseURL	Một tham số tích hợp sẵn phân giải thành URL cơ sở dữ liệu RTDB mặc định được liên kết với dự án mà không cần nhắc người triển khai. Chuỗi trống nếu không có chuỗi đó.
DeclaredParams (Tham số khai báo)
gcloudProject	Một tham số tích hợp sẵn phân giải thành Mã dự án trên đám mây mà không cần nhắc người triển khai.
projectID	Một tham số tích hợp sẵn phân giải thành Mã dự án trên đám mây được liên kết với dự án mà không cần nhắc người triển khai.
storageBucket (bộ chứa bộ nhớ)	Một tham số tích hợp phân giải thành bộ chứa Cloud Storage được liên kết với hàm mà không cần nhắc người triển khai. Chuỗi trống nếu không được xác định.

Nhập bí danh

Nhập bí danh	Mô tả
ParamOptions (Tuỳ chọn thông số)	Các tuỳ chọn cấu hình có thể dùng để tuỳ chỉnh hành vi nhắc của một tham số.

params.defineBoolean()

Khai báo tham số boolean.

Chữ ký:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

Thông số

Thông số	Loại	Mô tả
name	chuỗi	Tên của biến môi trường sẽ dùng để tải thông số.
tuỳ chọn	ParamOptions<boolean>	Các lựa chọn cấu hình cho tham số.

Trường hợp trả lại hàng:

Tham số Boolean

Một tham số có loại dữ liệu trả về boolean cho .value.

params.defineInt()

Khai báo một tham số số nguyên.

Chữ ký:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

Thông số

Thông số	Loại	Mô tả
name	chuỗi	Tên của biến môi trường sẽ dùng để tải thông số.
tuỳ chọn	ParamOptions<number>	Các lựa chọn cấu hình cho tham số.

Trường hợp trả lại hàng:

IntParam

Một tham số có loại dữ liệu trả về number cho .value.

params.defineList()

Khai báo tham số danh sách.

Chữ ký:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

Thông số

Thông số	Loại	Mô tả
name	chuỗi	Tên của biến môi trường sẽ dùng để tải thông số.
tuỳ chọn	ParamOptions<string[]>	Các lựa chọn cấu hình cho tham số.

Trường hợp trả lại hàng:

ListParam (Tham số danh sách)

Một tham số có loại dữ liệu trả về string[] cho .value.

params.defineSecret()

Khai báo một tham số bí mật. Tham số này sẽ chỉ lưu giữ các giá trị trong Trình quản lý bí mật trên đám mây. Khoá bí mật được lưu trữ nội bộ dưới dạng bytestring. Sử dụng ParamOptions.as để cung cấp gợi ý loại trong quá trình phân giải tham số.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
name	chuỗi	Tên của biến môi trường sẽ dùng để tải thông số.

Trường hợp trả lại hàng:

Tham số bí mật

Một tham số có loại dữ liệu trả về string cho .value.

params.defineString()

Khai báo một tham số chuỗi.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
name	chuỗi	Tên của biến môi trường sẽ dùng để tải thông số.
tuỳ chọn	ParamOptions<string>	Các lựa chọn cấu hình cho tham số.

Trường hợp trả lại hàng:

Tham số chuỗi

Một tham số có loại dữ liệu trả về string cho .value.

params.multiSelect()

Tạo dữ liệu đầu vào để chọn nhiều giá trị từ một chuỗi giá trị.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tuỳ chọn	chuỗi[]

Trường hợp trả lại hàng:

MultiSelectInput

params.multiSelect()

Tạo dữ liệu đầu vào có nhiều lựa chọn từ sơ đồ liên kết nhãn đến giá trị.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tuỳ chọn	Ghi <string, string>

Trường hợp trả lại hàng:

MultiSelectInput

params.select()

Tạo một giá trị đầu vào chọn lọc trong một chuỗi các giá trị.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tuỳ chọn	Đ[]

Trường hợp trả lại hàng:

SelectInput<T>

params.select()

Tạo một mục nhập lựa chọn từ sơ đồ liên kết nhãn đến giá trị.

Chữ ký:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

Thông số

Thông số	Loại	Mô tả
tuỳ chọnVớiNhãn	Ghi<string, T>

Trường hợp trả lại hàng:

SelectInput<T>

params.BUCKET_PICKER

Tự động tạo danh sách nhóm trong một dự án mà người dùng có thể chọn.

Chữ ký:

BUCKET_PICKER: ResourceInput

params.databaseURL

Một tham số tích hợp sẵn phân giải thành URL cơ sở dữ liệu RTDB mặc định được liên kết với dự án mà không cần nhắc người triển khai. Chuỗi trống nếu không có chuỗi đó.

Chữ ký:

databaseURL: Param<string>

params.manifestdParams

Chữ ký:

declaredParams: SecretOrExpr[]

params.gcloudProject

Một tham số tích hợp sẵn phân giải thành Mã dự án trên đám mây mà không cần nhắc người triển khai.

Chữ ký:

gcloudProject: Param<string>

params.projectID

Một tham số tích hợp sẵn phân giải thành Mã dự án trên đám mây được liên kết với dự án mà không cần nhắc người triển khai.

Chữ ký:

projectID: Param<string>

params.storageBucket

Một tham số tích hợp phân giải thành bộ chứa Cloud Storage được liên kết với hàm mà không cần nhắc người triển khai. Chuỗi trống nếu không được xác định.

Chữ ký:

storageBucket: Param<string>

params.ParamOptions

Các tuỳ chọn cấu hình có thể dùng để tuỳ chỉnh hành vi nhắc của một tham số.

Chữ ký:

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