https namespace

Chức năng

Chức năng Sự miêu tả
onCall(trình xử lý) Khai báo một phương thức có thể gọi để khách hàng gọi bằng SDK Firebase.
onRequest(trình xử lý) Xử lý các yêu cầu HTTP.

Các lớp học

Lớp học Sự miêu tả
HttpsLỗi Một lỗi rõ ràng có thể được đưa ra từ một trình xử lý để gửi lỗi đến máy khách đã gọi hàm.

Giao diện

Giao diện Sự miêu tả
Có thể gọi đượcContext Giao diện dành cho siêu dữ liệu của API được chuyển đến trình xử lý.
Lời yêu cầu Một yêu cầu rõ ràng với cách trình bày định dạng dây của nội dung yêu cầu.

Nhập bí danh

Nhập bí danh Sự miêu tả
Chức năngMã lỗi Tập hợp mã trạng thái Chức năng Firebase. Các mã giống nhau ở các mã được gRPC hiển thị .

https.onCall()

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

Chữ ký:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

Thông số

Tham số Kiểu Sự miêu tả
người xử lý (dữ liệu: bất kỳ, bối cảnh: CallableContext ) => bất kỳ | Hứa<bất kỳ> Một phương thức lấy dữ liệu và ngữ cảnh rồi trả về một giá trị.

Trả về:

HttpsChức năng & có thể chạy được <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ố

Tham số Kiểu Sự miêu tả
người xử lý (req: Yêu cầu, tương ứng: express.Response) => void | Hứa<void> Một hàm nhận đối tượng yêu cầu và phản hồi, có cùng chữ ký với ứng dụng Express.

Trả về:

Hàm Https

https.FunctionsErrorCode

Tập hợp mã trạng thái Chức năng Firebase. Các mã giống nhau ở các mã được gRPC hiển thị .

Những giá trị khả thi:

  • cancelled : Thao tác đã bị hủy (thường là do người gọi).

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

  • invalid-argument : Khách hàng đã chỉ định một đối số không hợp lệ. Lưu ý rằng điều 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 hoạt động có thể hoàn tất. Đối với các thao tác 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ụ: phản hồi thành công từ máy chủ có thể bị trì hoãn đủ lâu để hết 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 : Người gọi không có quyền thực hiện thao tác đã chỉ định.

  • resource-exhausted : Một số tài nguyên đã cạn kiệt, có thể là hạn ngạch 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ị hủy bỏ, thường là do sự cố xảy ra đồng thời như giao dịch bị hủy bỏ, v.v.

  • out-of-range : Hoạt động đã được thực hiện vượt quá phạm vi hợp lệ.

  • unimplemented : Hoạt động không được triển khai hoặc không được hỗ trợ/kích hoạt.

  • internal : Lỗi nội bộ. Có nghĩa là một số bất biến mà hệ thống cơ bản mong đợi đã bị phá vỡ. Nếu bạn thấy một trong những lỗi này, có nghĩa là có gì đó rất hỏng.

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

  • data-loss : Mất hoặc hỏng dữ liệu không thể phục hồi.

  • unauthenticated : Yêu cầu không có thông tin xác thực hợp lệ cho hoạt động.

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