ฟังก์ชั่น
| การทำงาน | คำอธิบาย |
|---|---|
| onCall (ตัวจัดการ) | ประกาศวิธีการที่เรียกได้เพื่อให้ไคลเอ็นต์โทรโดยใช้ Firebase SDK |
| onRequest (ตัวจัดการ) | จัดการคำขอ HTTP |
ชั้นเรียน
| ระดับ | คำอธิบาย |
|---|---|
| HttpsError | ข้อผิดพลาดที่ชัดเจนที่สามารถส่งจากตัวจัดการเพื่อส่งข้อผิดพลาดไปยังไคลเอนต์ที่เรียกว่าฟังก์ชัน |
อินเทอร์เฟซ
| อินเตอร์เฟซ | คำอธิบาย |
|---|---|
| CallableContext | อินเทอร์เฟซสำหรับข้อมูลเมตาสำหรับ API ที่ส่งผ่านไปยังตัวจัดการ |
| ขอ | คำขอด่วนพร้อมการแสดงรูปแบบเส้นลวดของเนื้อหาคำขอ |
พิมพ์นามแฝง
| พิมพ์นามแฝง | คำอธิบาย |
|---|---|
| ฟังก์ชั่นรหัสข้อผิดพลาด | ชุดรหัสสถานะฟังก์ชัน Firebase รหัสเหมือนกันกับรหัสที่ gRPC เปิดเผย . |
https.onCall()
ประกาศวิธีการที่เรียกได้เพื่อให้ไคลเอ็นต์โทรโดยใช้ Firebase SDK
ลายเซ็น:
export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวจัดการ | (ข้อมูล: ใด ๆ บริบท: CallableContext ) => ใดๆ | สัญญา<ใดๆ> | วิธีการที่ใช้ข้อมูลและบริบทและส่งกลับค่า |
ผลตอบแทน:
HttpsFunction & รันได้ <ใดๆ>
https.onRequest()
จัดการคำขอ HTTP
ลายเซ็น:
export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวจัดการ | (req: คำขอ, ตอบกลับ: express.Response) => void | สัญญา<โมฆะ> | ฟังก์ชันที่รับออบเจ็กต์คำขอและการตอบกลับ ซึ่งมีลายเซ็นเดียวกับแอป Express |
ผลตอบแทน:
https.FunctionsErrorCode
ชุดรหัสสถานะฟังก์ชัน Firebase รหัสเหมือนกันกับรหัสที่ gRPC เปิดเผย .
ค่าที่เป็นไปได้:
cancelled: การดำเนินการถูกยกเลิก (โดยทั่วไปโดยผู้โทร)unknown: ข้อผิดพลาดที่ไม่รู้จักหรือข้อผิดพลาดจากโดเมนข้อผิดพลาดอื่นinvalid-argument: ลูกค้าระบุอาร์กิวเมนต์ที่ไม่ถูกต้อง โปรดทราบว่าสิ่งนี้แตกต่างจากfailed-precondition.invalid-argumentบ่งชี้ถึงอาร์กิวเมนต์ที่เป็นปัญหาโดยไม่คำนึงถึงสถานะของระบบ (เช่นชื่อฟิลด์ที่ไม่ถูกต้อง)deadline-exceeded: หมดเขตก่อนที่การดำเนินการจะเสร็จสมบูรณ์ สำหรับการดำเนินการที่เปลี่ยนสถานะของระบบ ข้อผิดพลาดนี้อาจถูกส่งกลับแม้ว่าการดำเนินการจะเสร็จสมบูรณ์แล้วก็ตาม ตัวอย่างเช่น การตอบกลับที่สำเร็จจากเซิร์ฟเวอร์อาจมีความล่าช้านานพอที่จะหมดกำหนดเวลาnot-found: ไม่พบเอกสารที่ร้องขอบางรายการalready-exists: มีเอกสารบางฉบับที่เราพยายามสร้างอยู่แล้วpermission-denied: ผู้เรียกไม่ได้รับอนุญาตให้ดำเนินการตามที่ระบุresource-exhausted: ทรัพยากรบางส่วนหมดลง อาจเป็นโควต้าต่อผู้ใช้ หรือบางทีระบบไฟล์ทั้งหมดไม่มีพื้นที่เหลือfailed-precondition: การดำเนินการถูกปฏิเสธเนื่องจากระบบไม่อยู่ในสถานะที่จำเป็นสำหรับการดำเนินการของการดำเนินการaborted: การดำเนินการถูกยกเลิก โดยทั่วไปเนื่องจากปัญหาการทำงานพร้อมกัน เช่น การยกเลิกธุรกรรม ฯลฯout-of-range: มีความพยายามดำเนินการเกินช่วงที่ถูกต้องunimplemented: ไม่มีการดำเนินการหรือไม่รองรับ/เปิดใช้งานinternal: ข้อผิดพลาดภายใน หมายความว่าค่าคงที่บางตัวที่คาดไว้โดยระบบพื้นฐานนั้นเสียหาย หากคุณเห็นข้อผิดพลาดข้อใดข้อหนึ่ง แสดงว่ามีบางอย่างเสียหายมากunavailable: บริการไม่สามารถใช้งานได้ในขณะนี้ นี่น่าจะเป็นสภาวะชั่วคราวและอาจแก้ไขได้ด้วยการลองย้อนกลับอีกครั้งdata-loss: ข้อมูลสูญหายหรือเสียหายที่ไม่สามารถกู้คืนได้unauthenticated: คำขอไม่มีข้อมูลรับรองความถูกต้องที่ถูกต้องสำหรับการดำเนินการ
ลายเซ็น:
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";