https namespace

Hàm

Chức năng Mô tả
onCall(tối ưu hoá, trình xử lý) Khai báo một phương thức có thể gọi để ứng dụng khách gọi bằng Firebase SDK.
onCall(xử lý) Khai báo một phương thức có thể gọi để ứng dụng khách gọi bằng Firebase SDK.
onRequest(tối ưu hoá, trình xử lý) Xử lý các yêu cầu HTTPS.
onRequest(handler) Xử lý các yêu cầu HTTPS.

Lớp học

Hạng Mô tả
HttpsError Một lỗi rõ ràng có thể được gửi từ trình xử lý để gửi lỗi đến ứng dụng khách đã gọi hàm.

Giao diện

Giao diện Mô tả
CallableFunction Tạo một phương thức có thể gọi để ứng dụng khách gọi bằng cách sử dụng Firebase SDK.
CallableOptions (Tuỳ chọn có thể gọi) Bạn có thể đặt các tuỳ chọn cho hàm HTTPS có thể gọi.
CallableRequest Yêu cầu dùng để gọi một hàm có thể gọi.
HttpsOptions Bạn có thể đặt các tuỳ chọn trên hàm onRequest HTTPS.
Yêu cầu Một yêu cầu nhanh có định dạng dây đại diện cho phần nội dung yêu cầu.

Nhập bí danh

Nhập bí danh Mô tả
FunctionsErrorCode Tập hợp mã trạng thái của Hàm Firebase. Các mã này giống nhau với các mã do gRPC hiển thị.
HttpsFunction Xử lý các yêu cầu HTTPS.

https.onCall()

Khai báo một phương thức có thể gọi để ứng dụng khách gọi bằng Firebase SDK.

Chữ ký:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Thông số

Thông số Loại Mô tả
chọn CallableOptions (Tuỳ chọn có thể gọi) Các lựa chọn để đặt trên hàm này.
trình xử lý (yêu cầu: CallableRequest<T>) => Quay lại Một hàm nhận https.CallableRequest.

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

CallableFunction<T, Return>

Hàm mà bạn có thể xuất và triển khai.

https.onCall()

Khai báo một phương thức có thể gọi để ứng dụng khách gọi bằng Firebase SDK.

Chữ ký:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Thông số

Thông số Loại Mô tả
trình xử lý (yêu cầu: CallableRequest<T>) => Quay lại Một hàm nhận https.CallableRequest.

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

CallableFunction<T, Return>

Hàm mà bạn có thể xuất và triển khai.

https.onRequest()

Xử lý các yêu cầu HTTPS.

Chữ ký:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Thông số

Thông số Loại Mô tả
chọn HttpsOptions Các lựa chọn để đặt cho hàm này
trình xử lý (yêu cầu: Yêu cầu, phản hồi: express.Response) => vô hiệu | Lời hứa<vô hiệu> Hàm lấy https.Request và đối tượng phản hồi, có cùng chữ ký như ứng dụng Express.

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

HttpsFunction

Hàm mà bạn có thể xuất và triển khai.

https.onRequest()

Xử lý các yêu cầu HTTPS.

Chữ ký:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Thông số

Thông số Loại Mô tả
trình xử lý (yêu cầu: Yêu cầu, phản hồi: express.Response) => vô hiệu | Lời hứa<vô hiệu> Hàm lấy https.Request và đối tượng phản hồi, có cùng chữ ký như ứng dụng Express.

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

HttpsFunction

Hàm mà bạn có thể xuất và triển khai.

https.FunctionsErrorCode

Tập hợp mã trạng thái của Hàm Firebase. Các mã này giống nhau với các mã do gRPC hiển thị.

Các giá trị có thể có:

  • cancelled: Thao tác đã bị huỷ (thường do phương thức gọi thực hiện).

  • unknown: Lỗi không xác định hoặc lỗi từ một miền lỗi khác.

  • invalid-argument: Ứng dụng đã chỉ định một đối số không hợp lệ. Xin lưu ý rằng giá trị này khác với failed-precondition. invalid-argument cho biết các đối số có vấn đề bất kể trạng thái của hệ thống (ví dụ: tên trường không hợp lệ).

  • deadline-exceeded: Thời hạn đã hết trước khi thao tác có thể hoàn tất. Đối với những hoạt động thay đổi trạng thái của hệ thống, lỗi này có thể được trả về ngay cả khi thao tác đã hoàn tất thành công. Ví dụ: một phản hồi thành công từ máy chủ có thể bị trì hoãn đủ lâu đến thời hạn.

  • not-found: Không tìm thấy một số tài liệu được yêu cầu.

  • already-exists: Một số tài liệu mà chúng tôi cố gắng tạo đã tồn tại.

  • permission-denied: Phương thức gọi không có quyền thực thi thao tác đã chỉ định.

  • resource-exhausted: Một số tài nguyên đã hết, có thể đã hết hạn mức cho mỗi người dùng, hoặc có thể toàn bộ hệ thống tệp đã hết dung lượng.

  • failed-precondition: Thao tác bị từ chối vì hệ thống không ở trạng thái cần thiết để thực thi thao tác.

  • aborted: Thao tác bị huỷ, thường là do sự cố đồng thời như giao dịch bị huỷ, v.v.

  • out-of-range: Đã cố gắng thực hiện thao tác trong phạm vi hợp lệ.

  • unimplemented: Thao tác chưa được triển khai hoặc không được hỗ trợ/bật.

  • internal: Lỗi nội bộ. Có nghĩa là một số bất biến dự kiến của hệ thống cơ bản đã bị hỏng. Nếu bạn thấy một trong những lỗi này, tức là đã xảy ra lỗi.

  • unavailable: Dịch vụ hiện không hoạt động. Đây rất có thể là một tình trạng tạm thời và có thể được khắc phục bằng cách thử lại bằng thuật toán thời gian đợi.

  • data-loss: Lỗi hoặc mất dữ liệu không thể khôi phục.

  • unauthenticated: Yêu cầu không có thông tin xác thực hợp lệ cho thao tác này.

Chữ ký:

export type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";

https.HttpsFunction

Xử lý các yêu cầu HTTPS.

Chữ ký:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};