firebase-functions package

API thế hệ thứ 2 dành cho Chức năng đám mây cho Firebase. SDK này hỗ trợ nhập sâu. Ví dụ: không gian tên pubsub có sẵn tại firebase-functions/v2 hoặc có thể nhập trực tiếp từ firebase-functions/v2/pubsub .

Chức năng

Chức năng Sự miêu tả
setGlobalOptions(tùy chọn) Đặt các tùy chọn mặc định cho tất cả các chức năng được viết bằng SDK thế hệ 2.

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 onWriteonUpdate 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.

Giao diện

Giao diện Sự miêu tả
Đám MâySự Kiện (BETA) CloudEventBase là nền tảng của định dạng đa nền tảng để mã hóa sự kiện không có máy chủ. Để biết thêm thông tin, hãy xem https://github.com/cloudevents/spec.
Chức năng đám mây (BETA) Trình xử lý cho CloudEvents.
Tùy chọn xử lý sự kiện Các trường bổ sung có thể được đặt trên bất kỳ chức năng xử lý sự kiện nào.
Tùy chọn toàn cầu GlobalOptions là các tùy chọn có thể được đặt trên toàn bộ dự án. Các tùy chọn này phổ biến đối với HTTPS và các chức năng xử lý sự kiện.

Không gian tên

Không gian tên Sự miêu tả
cảnh báo
cơ sở dữ liệu
vòng cung sự kiện
lò sưởi
https
danh tính
tiều phu
thông số
pubsub
cấu hình từ xa
Người lập kế hoạch
kho
nhiệm vụ
phòng thí nghiệm thử nghiệm

Nhập bí danh

Nhập bí danh Sự miêu tả
Cài đặt xâm nhập Danh sách các tùy chọn có sẵn cho IngressSettings .
Tùy chọn bộ nhớ Danh sách các tùy chọn bộ nhớ khả dụng được Cloud Functions hỗ trợ.
Thông số Một loại ánh xạ tất cả nhóm thu thập tham số vào các khóa của bản ghi. Ví dụ: ParamsOf < "người dùng/ { uid } " > là { uid: string } ParamsOf < "người dùng/ { uid } /nhật ký/ { nhật ký } " > là { uid: chuỗi; log: string } ParamsOf < "một số/tĩnh/dữ liệu" > là { } Vì lý do linh hoạt, ParamsOf là Bản ghi < chuỗi, chuỗi >
Khu vực được hỗ trợ Danh sách tất cả các khu vực được Cloud Functions hỗ trợ (thế hệ 2).
VpcEgressSetting Danh sách các tùy chọn có sẵn cho VpcConnectorEgressSettings .

setGlobalOptions()

Đặt các tùy chọn mặc định cho tất cả các chức năng được viết bằng SDK thế hệ 2.

Chữ ký:

export declare function setGlobalOptions(options: GlobalOptions): void;

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Tùy chọn toàn cầu Tùy chọn để đặt làm mặc định

Trả về:

trống rỗng

Cài đặt xâm nhập

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

Chữ ký:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

Tùy chọn bộ nhớ

Danh sách các tùy chọn bộ nhớ khả dụng được Cloud Functions hỗ trợ.

Chữ ký:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

Thông số

Một loại ánh xạ tất cả nhóm thu thập tham số vào các khóa của bản ghi. Ví dụ: ParamsOf < "người dùng/ { uid } " > là { uid: string } ParamsOf < "người dùng/ { uid } /nhật ký/ { nhật ký } " > là { uid: chuỗi; log: string } ParamsOf < "một số/tĩnh/dữ liệu" > là { }

Vì lý do linh hoạt, ParamsOf là Bản ghi < chuỗi, chuỗi >

Chữ ký:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

Khu vực được hỗ trợ

Danh sách tất cả các khu vực được Cloud Functions hỗ trợ (thế hệ 2).

Chữ ký:

export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";

VpcEgressSetting

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

Chữ ký:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";