https namespace

Hàm

Chức năng Mô tả
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(handler) Xử lý các yêu cầu HTTP.

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ả
CallableContext Giao diện cho siêu dữ liệu dành cho API khi được truyền đến trình xử lý.
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ị.

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(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

Thông số

Thông số Loại Mô tả
trình xử lý (dữ liệu: bất kỳ, ngữ cảnh: CallableContext) => bất kỳ | Cam kết<bất kỳ> Phương thức nhận dữ liệu và ngữ cảnh rồi trả về một giá trị.

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

HttpsFunction và Có thể chạy<bất kỳ>

https.onRequest()

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

Chữ ký:

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

Thông số

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

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

HttpsFunction

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";