Chức năng
| Chức năng | Sự miêu tả |
|---|---|
| định nghĩaBoolean(tên, tùy chọn) | Khai báo một tham số boolean. |
| Định nghĩaInt(tên, tùy chọn) | Khai báo một tham số nguyên. |
| xác địnhList(tên, tùy chọn) | Khai báo một danh sách param. |
| xác địnhBí mật(tên) | Khai báo một thông số bí mật, thông số này sẽ chỉ duy trì các giá trị trong Cloud Secret Manager. Bí mật được lưu trữ nội bộ dưới dạng bytestrings. Sử dụng ParamOptions. as cung cấp gợi ý loại trong quá trình phân giải tham số. |
| xác địnhString(tên, tùy chọn) | Khai báo một tham số chuỗi. |
Các lớp học
| Lớp học | Sự miêu tả |
|---|---|
| Sự biểu lộ |
Biến
| Biến đổi | Sự miêu tả |
|---|---|
| cơ sở dữ liệuURL | Một thông số dựng sẵn phân giải 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 tồn tại. |
| khai báoParams | |
| dự án gcloud | Thông số dựng sẵn phân giải thành ID dự án trên đám mây mà không cần nhắc người triển khai. |
| ID dự án | Thông số dựng sẵn phân giải thành ID 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. |
| lưu trữNhóm | Một thông số dựng sẵn phân giải tới nhóm lưu trữ Đám mây được liên kết với chức năng 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 | Sự miêu tả |
|---|---|
| Tùy chọn thông số | Các tùy chọn cấu hình có thể được sử dụng để tùy chỉnh hành vi nhắc nhở của Thông số. |
params.defineBoolean()
Khai báo một tham số boolean.
Chữ ký:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải thông số. |
| tùy chọn | Tùy chọn thông số <boolean> | Tùy chọn cấu hình cho thông số. |
Trả về:
BooleanParam
Một thông số có kiểu trả về boolean cho .value .
params.defineInt()
Khai báo một tham số nguyên.
Chữ ký:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải thông số. |
| tùy chọn | Tùy chọn thông số <số> | Tùy chọn cấu hình cho thông số. |
Trả về:
IntParam
Một thông số có kiểu trả về number cho .value .
params.defineList()
Khai báo một danh sách param.
Chữ ký:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải thông số. |
| tùy chọn | Tùy chọn thông số <chuỗi[]> | Tùy chọn cấu hình cho thông số. |
Trả về:
Danh sáchParam
Một thông số có kiểu trả về string[] cho .value .
params.defineSecret()
Khai báo một thông số bí mật, thông số này sẽ chỉ duy trì các giá trị trong Cloud Secret Manager. Bí mật được lưu trữ nội bộ dưới dạng bytestrings. 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ố
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải thông số. |
Trả về:
Thông số bí mật
Một thông số có kiể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ố
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| tên | sợi dây | Tên của biến môi trường sẽ sử dụng để tải thông số. |
| tùy chọn | Tùy chọn thông số <chuỗi> | Tùy chọn cấu hình cho thông số. |
Trả về:
ChuỗiParam
Một thông số có kiểu trả về string cho .value .
params.databaseURL
Một thông số dựng sẵn phân giải 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 tồn tại.
Chữ ký:
databaseURL: Param<string>
params.declaredParams
Chữ ký:
declaredParams: SecretOrExpr[]
params.gcloudDự án
Thông số dựng sẵn phân giải thành ID dự án trên đám mây mà không cần nhắc người triển khai.
Chữ ký:
gcloudProject: Param<string>
thông số.projectID
Thông số dựng sẵn phân giải thành ID 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 thông số dựng sẵn phân giải tới nhóm lưu trữ Đám mây được liên kết với chức năng 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 tùy chọn cấu hình có thể được sử dụng để tùy chỉnh hành vi nhắc nhở của Thông số.
Chữ ký:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;