functions package

Cloud Functions cho Firebase

Hàm

Chức năng Mô tả
hàm(app, ...)
getFunctions(app, regionOrCustomMiền) Trả về một thực thể Function (Hàm) của ứng dụng cho sẵn.
hàm(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, máy chủ, cổng) Sửa đổi thực thể này để giao tiếp với trình mô phỏng Cloud Functions.Lưu ý: phải gọi thực thể này trước khi dùng thực thể này để thực hiện bất kỳ thao tác nào.
httpsCallable(functionsInstance, name, options) Trả về thông tin tham chiếu đến điều kiện kích hoạt HTTPS có thể gọi cùng với tên cho sẵn.
httpsCallableFromURL(functionsInstance, url, tuỳ chọn) Trả về thông tin tham chiếu đến điều kiện kích hoạt HTTPS có thể gọi kèm theo URL được chỉ định.

Giao diện

Giao diện Mô tả
Hàm Một thực thể Functions.
FunctionsError Lỗi do SDK ứng dụng Hàm Firebase trả về.
HttpsCallableOptions Một giao diện cho siêu dữ liệu về cách thực thi lệnh gọi.
HttpsCallableResult HttpsCallableResult gói một kết quả duy nhất từ lệnh gọi hàm.

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 ở những mã được gRPC hiển thị ở đây: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdCác giá trị có thể: – ''đã huỷ'': Thao tác đã bị huỷ (thường là do người gọi). – "không xác định": Lỗi không xác định hoặc lỗi từ một miền lỗi khác. – 'Illegal- đối số': Ứng dụng khách chỉ định đối số không hợp lệ. Xin lưu ý rằng thuộc tính này khác với "failed-precondition" (điều kiện tiên quyết không thành công). "đối số không hợp lệ" 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-vượt quá": 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. – "đã-có": 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. – "tài nguyên đã hết": Một số tài nguyên đã hết, có thể đã đạt đến 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. - 'bị huỷ': Thao tác bị huỷ, thường là do sự cố đồng thời như giao dịch bị huỷ, v.v. - 'ngoài phạm vi': Thao tác đã cố gắng vượt quá phạm vi hợp lệ. – "chưa triển khai": 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. – 'không có sẵn': 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. – "Mất dữ liệu": Mất hoặc hỏng dữ liệu không thể khôi phục. - "chưa được xác thực": Yêu cầu không có thông tin xác thực hợp lệ cho thao tác này.
FunctionsErrorCodeCore Chuỗi mã lỗi của hàm được thêm vào sau "functions/" tiền tố sản phẩm. Xem FunctionsErrorCode để biết tài liệu đầy đủ về mã.
HttpsCallable Tham chiếu đến "có thể gọi" Trình kích hoạt HTTP trong Google Cloud Functions.

function(app, ...)

getFunctions(ứng dụng, vùngOrCustomMiền)

Trả về một thực thể Function (Hàm) của ứng dụng cho sẵn.

Chữ ký:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Firebase FirebaseApp để sử dụng.
khu vựcHoặcTuỳ chỉnh Miền chuỗi một trong: a) Vùng đặt các hàm có thể gọi (ví dụ: us-central1) b) Một miền tuỳ chỉnh lưu trữ các hàm có thể gọi (ví dụ: https://mydomain.com)

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

Hàm

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, máy chủ, cổng)

Sửa đổi phiên bản này để giao tiếp với trình mô phỏng Cloud Functions.

Chữ ký:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

Thông số

Thông số Loại Mô tả
functionInstance Hàm
máy chủ lưu trữ chuỗi Máy chủ lưu trữ trình mô phỏng (ví dụ: localhost)
cổng số Cổng trình mô phỏng (ví dụ: 5001)

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

trống

httpsCallable(functionsInstance, tên, tuỳ chọn)

Trả về thông tin tham chiếu đến điều kiện kích hoạt HTTPS có thể gọi cùng với tên cho sẵn.

Chữ ký:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Thông số

Thông số Loại Mô tả
functionInstance Hàm
name chuỗi Tên trình kích hoạt.
tuỳ chọn HttpsCallableOptions

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

HttpsCallable<RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, tuỳ chọn)

Trả về thông tin tham chiếu đến điều kiện kích hoạt HTTPS có thể gọi kèm theo URL được chỉ định.

Chữ ký:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Thông số

Thông số Loại Mô tả
functionInstance Hàm
url chuỗi URL của điều kiện kích hoạt.
tuỳ chọn HttpsCallableOptions

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

HttpsCallable<RequestData, ResponseData>

Mã chức năng

Tập hợp mã trạng thái của Hàm Firebase. Các mã giống nhau ở những mã được gRPC hiển thị ở đây: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Các giá trị có thể có: - 'đã huỷ': Thao tác đã bị huỷ (thường do người gọi thực hiện). – "không xác định": Lỗi không xác định hoặc lỗi từ một miền lỗi khác. – 'Illegal- đối số': Ứng dụng khách chỉ định đối số không hợp lệ. Xin lưu ý rằng thuộc tính này khác với "failed-precondition" (điều kiện tiên quyết không thành công). "đối số không hợp lệ" 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-vượt quá": 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. – "đã-có": 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. – "tài nguyên đã hết": Một số tài nguyên đã hết, có thể đã đạt đến 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. - 'bị huỷ': Thao tác bị huỷ, thường là do sự cố đồng thời như giao dịch bị huỷ, v.v. - 'ngoài phạm vi': Thao tác đã cố gắng vượt quá phạm vi hợp lệ. – "chưa triển khai": 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. – 'không có sẵn': 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. – "Mất dữ liệu": Mất hoặc hỏng dữ liệu không thể khôi phục. - "chưa được xác thực": 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 declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

Chức năngErrorCodeCore

Chuỗi mã lỗi của hàm được thêm vào sau "functions/" tiền tố sản phẩm. Xem FunctionsErrorCode để biết tài liệu đầy đủ về mã.

Chữ ký:

export declare type FunctionsErrorCodeCore = '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';

HttpsCallable

Tham chiếu đến "có thể gọi" Trình kích hoạt HTTP trong Google Cloud Functions.

Chữ ký:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;