functions package

Chức năng đám mây cho Firebase

Chức năng

Giao diện

Nhập bí danh

chức năng (ứng dụng, ...)

getFunctions(ứng dụng, vùngOrCustomDomain)

Trả về một phiên bản Hàm cho ứng dụng đã cho.

Chữ ký:

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

Thông số

Trả về:

Chức năng

hàm(hàmInstance, ...)

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ố

Trả về:

trống rỗng

httpsCallable(functionsInstance, name, options)

Trả về tham chiếu đến trình kích hoạt HTTPS có thể gọi được với tên đã cho.

Chữ ký:

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

Thông số

Trả về:

HttpsCó thể gọi được <Dữ liệu yêu cầu, Dữ liệu phản hồi>

httpsCallableFromURL(functionsInstance, url, options)

Trả về tham chiếu đến trình kích hoạt HTTPS có thể gọi được với url đã chỉ định.

Chữ ký:

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

Thông số

Trả về:

HttpsCó thể gọi được <Dữ liệu yêu cầu, Dữ liệu phản hồi>

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ị tại đây: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Các giá trị có thể có: - 'cancelled': Thao tác đã bị hủy (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ừ miền lỗi khác. - 'đối số không hợp lệ': 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 'đ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ệ). - 'vượt quá thời hạn': 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. - 'đã tồn tại': Một số tài liệu mà chúng tôi cố gắng tạo đã tồn tại. - 'bị từ chối cấp phép': Người gọi không có quyền thực hiện thao tác đã chỉ định. - 'cạn kiệt tài nguyên': 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. - 'điều kiện tiên quyết không thành công': 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ị hủy bỏ': Hoạt động đã bị hủy bỏ, thường là do sự cố đồng thời như hủy bỏ giao dịch, v.v. - 'ngoài phạm vi': Hoạt động đã được thử vượt quá phạm vi hợp lệ. - 'chưa thực hiện': Thao tác 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. - 'không khả dụng': Dịch vụ 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ờ. - 'mất dữ liệu': Mất hoặc hỏng dữ liệu không thể phục hồi. - 'không được xác thực': Yêu cầu không có thông tin xác thực hợp lệ cho hoạt động.

Chữ ký:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

Chức năngErrorCodeCore

Chuỗi mã lỗi hàm được thêm vào sau tiền tố sản phẩm "functions/". 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';

HttpsCó thể gọi được

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

Chữ ký:

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