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 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ữ xen kẽ dưới dạng chuỗi byte. Sử dụng ParamOptions.as để cung cấp gợi ý về loại trong quá trình phân giải tham số.
defineString(name, options) Khai báo tham số chuỗi.

Lớp học

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

Biến

Biến Mô tả
databaseURL Một tham số tích hợp 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 thông số tích hợp 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 sẵn phân giải sang 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ẽ được sử dụng để tải thông số.
tuỳ chọn ParamOptions<boolean> Các lựa chọn cấu hình cho thông số.

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

Tham số Boolean

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

params.defineInt()

Khai báo 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ẽ được sử dụng để tải thông số.
tuỳ chọn ParamOptions<number> Các lựa chọn cấu hình cho thông số.

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

IntParam

Một tham số có kiểu 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ẽ được sử dụng để tải thông số.
tuỳ chọn ParamOptions<string[]> Các lựa chọn cấu hình cho thông số.

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

ListParam (Tham số danh sách)

Một tham số có kiểu 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ữ xen kẽ dưới dạng chuỗi byte. Sử dụng ParamOptions.as để cung cấp gợi ý về 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ẽ được 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ó kiểu dữ liệu trả về string cho .value.

params.defineString()

Khai báo 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ẽ được sử dụng để tải thông số.
tuỳ chọn ParamOptions<string> Các lựa chọn cấu hình cho thông số.

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

Tham số chuỗi

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

params.databaseURL

Một tham số tích hợp 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 thông số tích hợp 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 sẵn phân giải sang 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">;