firebase-functions package

Chức năng

Chức năng Sự miêu tả
cấu hình() Lưu trữ và truy xuất dữ liệu cấu hình dự án như khóa API của bên thứ ba hoặc các cài đặt khác. Bạn có thể đặt giá trị cấu hình bằng Firebase CLI như được mô tả trong [Cấu hình môi trường](/docs/functions/config-env).
tùy chọnToEndpoint(tùy chọn)
tùy chọnToTrigger(tùy chọn)
khu vực (khu vực) Định cấu hình các khu vực mà chức năng được triển khai.
runWith(runtimeOptions) Định cấu hình các tùy chọn thời gian chạy cho hàm.

Các lớp học

Lớp học Sự miêu tả
Thay đổi Giao diện Cloud Functions dành cho các sự kiện thay đổi trạng thái, chẳng hạn như Cơ sở dữ liệu thời gian thực hoặc các sự kiện onWrite và onUpdate của Cloud Firestore. Để biết thêm thông tin về định dạng được sử dụng để xây dựng các đối tượng Change , hãy xem bên dưới.
Trình tạo hàm

Giao diện

Giao diện Sự miêu tả
Chức năng chặn Loại chức năng cho trình kích hoạt Chặn xác thực.
Chức năng đám mây Loại chức năng cho tất cả các trình kích hoạt không phải HTTPS. Điều này sẽ được xuất từ ​​tệp JavaScript của bạn để xác định Hàm đám mây. Loại này là một hàm JavaScript đặc biệt lấy đối tượng Event được tạo khuôn mẫu làm đối số duy nhất.
Tùy chọn triển khai Tùy chọn cấu hình cho chức năng áp dụng trong quá trình triển khai chức năng.
Sự kiện Định dạng dây cho một sự kiện.
Bối cảnh sự kiện Bối cảnh trong đó một sự kiện xảy ra.
Chính sách thất bại Tùy chọn cấu hình cho chính sách lỗi trên các chức năng nền.
Hàm Https Loại chức năng cho trình kích hoạt HTTPS. Điều này sẽ được xuất từ ​​tệp JavaScript của bạn để xác định Hàm đám mây.
Nguồn Tài nguyên là định dạng chuẩn để xác định tài nguyên (google.rpc.context.AttributionContext.Resource). Trong Chức năng đám mây, chính tài nguyên đã kích hoạt chức năng - chẳng hạn như nhóm lưu trữ.
Có thể chạy được Runnable có một phương thức run gọi trực tiếp hàm do người dùng xác định - hữu ích cho việc kiểm tra đơn vị.
Tùy chọn thời gian chạy Tùy chọn cấu hình cho chức năng có thể áp dụng trong thời gian chạy.
Lịch trình Tùy chọn cấu hình cho các chức năng được lên lịch.
Lịch trìnhThử lạiCấu hình Tùy chọn thử lại bộ lập lịch. Chỉ áp dụng cho các chức năng đã lên lịch.

Không gian tên

Không gian tên Sự miêu tả
phân tích
xác thực
cơ sở dữ liệu
lò sưởi
https
tiều phu
thông số
pubsub
cấu hình từ xa
kho
nhiệm vụ
phòng thí nghiệm thử nghiệm

Biến

Biến đổi Sự miêu tả
ứng dụng
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS Danh sách các tùy chọn có sẵn cho IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Giá trị thời gian chờ tối đa của Chức năng đám mây.
MIN_TIMEOUT_SECONDS Giá trị thời gian chờ tối thiểu của Chức năng đám mây.
ĐẶT LẠI_VALUE Giá trị cấu hình đặc biệt để đặt lại cấu hình về mặc định của nền tảng.
HỖ TRỢ_REGIONS Danh sách tất cả các khu vực được Cloud Functions hỗ trợ.
VALID_MEMORY_OPTIONS Danh sách các tùy chọn bộ nhớ khả dụng được Cloud Functions hỗ trợ.
VPC_EGRESS_SETTINGS_OPTIONS Danh sách các tùy 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 như khóa API của bên thứ ba hoặc các cài đặt khác. Bạn có thể đặt giá trị cấu hình bằng Firebase CLI như được mô tả trong [Cấu hình môi trường](/docs/functions/config-env).

Chữ ký:

export declare function config(): Record<string, any>;

Trả về:

Bản ghi<chuỗi, bất kỳ>

tùy chọnToEndpoint()

Chữ ký:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Tùy chọn triển khai

Trả về:

Điểm cuối của bảng kê khai

tùy chọnToTrigger()

Chữ ký:

export declare function optionsToTrigger(options: DeploymentOptions): any;

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Tùy chọn triển khai

Trả về:

bất kì

vùng đất()

Định cấu hình các khu vực mà chức năng được triển khai.

Chữ ký:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Thông số

Tham số Kiểu Sự miêu tả
vùng Mảng<(typeof SUPPORTED_REGIONS )[số] | chuỗi | Sự biểu lộ <chuỗi> | Đặt lại giá trị> Một trong nhiều chuỗi khu vực.

Trả về:

Trình tạo hàm

ví dụ 1

hàm.khu vực ('us-east1')

Ví dụ 2

Hàm.khu vực('us-east1', 'us-central1')

runWith()

Định cấu hình các tùy chọn thời gian chạy cho hàm.

Chữ ký:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn thời gian chạy Tùy chọn thời gian chạy Đối tượng có các trường tùy chọn: 1. memory : dung lượng bộ nhớ để phân bổ cho hàm, các giá trị có thể là: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' và '8GB' . 2. timeoutSeconds : thời gian chờ của hàm tính bằng giây, các giá trị có thể 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 : id của một VPC Connector trong cùng dự án và khu vực. 5. vpcConnectorEgressSettings : khi vpcConnector được đặt, hãy kiểm soát lưu lượng truy cập đầu ra nào được gửi qua vpcConnector. 6. serviceAccount : Tài khoản dịch vụ cụ thể cho chức năng. 7. ingressSettings : cài đặt ingress cho hàm, kiểm soát vị trí có thể gọi hàm HTTPS. Giá trị không được rỗng.

Trả về:

Trình tạo hàm

ứng dụng

Chữ ký:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Chữ ký:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

Danh sách các tùy chọn có sẵn cho IngressSettings.

Chữ ký:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

Chữ ký:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Giá trị thời gian chờ tối đa của Chức năng đám mây.

Chữ ký:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Giá trị thời gian chờ tối thiểu của Chức năng đá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ề mặc định của nền tảng.

Chữ ký:

RESET_VALUE: ResetValue

HỖ TRỢ_REGIONS

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 tùy chọn bộ nhớ khả dụng được 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 tùy chọn có sẵn cho VpcConnectorEgressSettings.

Chữ ký:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]