Hàm
| Chức năng | Mô tả |
|---|---|
| config() | Lưu trữ và truy xuất dữ liệu cấu hình dự án, chẳng hạn như khoá API của bên thứ ba hoặc các chế độ cài đặt khác. Bạn có thể đặt các giá trị cấu hình bằng giao diện dòng lệnh (CLI) của Firebase như mô tả trong phần [Cấu hình môi trường](/docs/functions/config-env). |
| optionsToEndpoint(options) | |
| optionsToTrigger(options) | |
| region(khu vực) | Định cấu hình những khu vực triển khai hàm. |
| runWith(runtimeOptions) | Định cấu hình các tuỳ chọn thời gian chạy cho hàm. |
Lớp học
| Hạng | Mô tả |
|---|---|
| Thay đổi | Giao diện Cloud Functions cho các sự kiện thay đổi trạng thái, chẳng hạn như Cơ sở dữ liệu theo thời gian thực hoặc các sự kiện onWrite và onUpdate trên Cloud Firestore.Để biết thêm thông tin về định dạng dùng để tạo đối tượng Change, hãy xem phần bên dưới. |
| FunctionBuilder |
Giao diện
| Giao diện | Mô tả |
|---|---|
| Chặn Hàm | Loại hàm cho trình kích hoạt Chặn xác thực. |
| Chức năng đám mây | Loại hàm cho tất cả điều kiện kích hoạt không phải HTTPS. Bạn nên xuất mã này từ tệp JavaScript để định nghĩa một Hàm đám mây.Loại này là một hàm JavaScript đặc biệt. Hàm này sẽ lấy một đối tượng Event theo mẫu làm đối số duy nhất. |
| DeploymentOptions (Tuỳ chọn triển khai) | Các lựa chọn cấu hình cho một hàm áp dụng trong quá trình triển khai hàm. |
| Sự kiện | Định dạng chuỗi cho một sự kiện. |
| EventContext | Bối cảnh trong đó một sự kiện đã xảy ra. |
| Chính sách về lỗi | Tuỳ chọn cấu hình cho chính sách lỗi đối với các hàm ở chế độ nền. |
| HttpsFunction | Loại hàm cho điều kiện kích hoạt HTTPS. Bạn nên xuất mã này từ tệp JavaScript để xác định một Hàm đám mây. |
| Tài nguyên | Tài nguyên là một định dạng chuẩn để xác định tài nguyên (google.rpc.context.AttributeContext.Resource). Trong Cloud Functions, đây là tài nguyên đã kích hoạt hàm này, chẳng hạn như một bộ chứa lưu trữ. |
| Có thể chạy | Runnable có phương thức run trực tiếp gọi hàm do người dùng xác định – hữu ích cho việc kiểm thử đơn vị. |
| RuntimeOptions (Tuỳ chọn thời gian chạy) | Các lựa chọn cấu hình cho một hàm có thể áp dụng trong thời gian chạy. |
| Lịch biểu | Các tuỳ chọn cấu hình cho các hàm được lên lịch. |
| ScheduleThửConfig | Các tuỳ chọn thử lại của trình lập lịch biểu. Chỉ áp dụng cho các hàm được lên lịch. |
Không gian tên
| Không gian tên | Mô tả |
|---|---|
| số liệu phân tích | |
| xác thực | |
| cơ sở dữ liệu | |
| firestore | |
| https | |
| người ghi nhật ký | |
| tham số | |
| pubsub | |
| remoteConfig | |
| bộ nhớ | |
| việc cần làm | |
| testLab |
Biến
| Biến | Mô tả |
|---|---|
| ứng dụng | |
| MẶC ĐỊNH_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | Danh sách tuỳ chọn hiện có cho IngressSettings. |
| MAX_NUMBER_USER_LABEL | |
| MAX_TIMEOUT_SECONDS | Giá trị thời gian chờ tối đa của Hàm đám mây. |
| MIN_TIMEOUT_SECONDS | Giá trị thời gian chờ tối thiểu của Hàm đám mây. |
| Reset_VALUE | Giá trị cấu hình đặc biệt để đặt lại cấu hình về chế độ mặc định của nền tảng. |
| KHU VỰC HỖ TRỢ | Danh sách tất cả các khu vực được Cloud Functions hỗ trợ. |
| VALID_MEMORY_OPTIONS | Danh sách các tuỳ chọn bộ nhớ còn trống mà Cloud Functions hỗ trợ. |
| VPC_EGRESS_SETTINGS_OPTIONS | Danh sách các tuỳ chọn có sẵn cho VpcconnectorEgressSettings. |
cấu hình()
Lưu trữ và truy xuất dữ liệu cấu hình dự án, chẳng hạn như khoá API của bên thứ ba hoặc các chế độ cài đặt khác. Bạn có thể đặt các giá trị cấu hình bằng giao diện dòng lệnh (CLI) của Firebase như mô tả trong phần [Cấu hình môi trường](/docs/functions/config-env).
Chữ ký:
export declare function config(): Record<string, any>;
Trường hợp trả lại hàng:
Ghi <string, any>
optionsToEndpoint()
Chữ ký:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| tuỳ chọn | DeploymentOptions (Tuỳ chọn triển khai) |
Trường hợp trả lại hàng:
Điểm cuối tệp kê khai
optionsToTrigger()
Chữ ký:
export declare function optionsToTrigger(options: DeploymentOptions): any;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| tuỳ chọn | DeploymentOptions (Tuỳ chọn triển khai) |
Trường hợp trả lại hàng:
bất kỳ
khu vực()
Định cấu hình những khu vực triển khai hàm.
Chữ ký:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| vùng | Mảng<(loại của supported_REGIONS)[number] | chuỗi | Biểu thức<string> | Đặt lại giá trị> | Một trong nhiều chuỗi khu vực. |
Trường hợp trả lại hàng:
Ví dụ 1
function.region('us-east1')
Ví dụ 2
function.region('us-east1', 'us-central1')
runWith()
Định cấu hình các tuỳ chọn thời gian chạy cho hàm.
Chữ ký:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| RuntimeOptions | RuntimeOptions (Tuỳ chọn thời gian chạy) | Đối tượng có các trường không bắt buộc: 1. memory: dung lượng bộ nhớ cần phân bổ cho hàm, có thể sử dụng các giá trị sau: "128MB", "256MB", "512MB", "1GB", "2GB", "4GB" và "8GB". 2. timeoutSeconds: thời gian chờ cho hàm tính bằng giây, các giá trị có thể có là từ 0 đến 540. 3. failurePolicy: chính sách lỗi của hàm, với boolean true tương đương với việc cung cấp một đối tượng thử lại trống. 4. vpcConnector: mã của trình kết nối VPC trong cùng dự án và khu vực. 5. vpcConnectorEgressSettings: khi bạn thiết lập vpcConnection, kiểm soát lưu lượng ra được gửi thông qua vpc Connector. 6. serviceAccount: Tài khoản dịch vụ cụ thể cho hàm. 7. ingressSettings: chế độ cài đặt lưu lượng vào cho hàm. Chế độ này kiểm soát nơi có thể gọi hàm HTTPS.Giá trị không được là giá trị rỗng. |
Trường hợp trả lại hàng:
ứng dụng
Chữ ký:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
MẶC ĐỊNH_FAILURE_POLICY
Chữ ký:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
Danh sách tuỳ chọn hiện có cho IngressSettings.
Chữ ký:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABEL
Chữ ký:
MAX_NUMBER_USER_LABELS = 58
MAX_TIMEOUT_SECONDS
Giá trị thời gian chờ tối đa của Hàm đám mây.
Chữ ký:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Giá trị thời gian chờ tối thiểu của Hàm đám mây.
Chữ ký:
MIN_TIMEOUT_SECONDS = 0
ĐẶT LẠI_VALUE
Giá trị cấu hình đặc biệt để đặt lại cấu hình về chế độ mặc định của nền tảng.
Chữ ký:
RESET_VALUE: ResetValue
KHU VỰC HỖ TRỢ
Danh sách tất cả các khu vực được Cloud Functions hỗ trợ.
Chữ ký:
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
VALID_MEMORY_OPTIONS
Danh sách các tuỳ chọn bộ nhớ còn trống mà Cloud Functions hỗ trợ.
Chữ ký:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
Danh sách các tuỳ chọn có sẵn cho VpcconnectorEgressSettings.
Chữ ký:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]