ฟังก์ชัน
ฟังก์ชัน | คำอธิบาย |
---|---|
onCall(ตัวเลือก, เครื่องจัดการ) | ประกาศเมธอดที่เรียกใช้ได้เพื่อให้ลูกค้าเรียกใช้ได้โดยใช้ Firebase SDK |
onCall(แฮนเดิล) | ประกาศเมธอดที่เรียกใช้ได้เพื่อให้ลูกค้าเรียกใช้ได้โดยใช้ Firebase SDK |
onRequest(ตัวเลือก, เครื่องจัดการ) | จัดการคำขอ HTTPS |
onRequest(แฮนเดิล) | จัดการคำขอ HTTPS |
ชั้นเรียน
ชั้น | คำอธิบาย |
---|---|
HttpsError | ข้อผิดพลาดที่ชัดเจนอาจเกิดจากตัวแฮนเดิลเพื่อส่งข้อผิดพลาดไปยังไคลเอ็นต์ที่เรียกใช้ฟังก์ชัน |
อินเทอร์เฟซ
อินเทอร์เฟซ | คำอธิบาย |
---|---|
ฟังก์ชัน Callable | สร้างเมธอดที่เรียกได้ให้ลูกค้าเรียกใช้โดยใช้ Firebase SDK |
ตัวเลือกการโทร | ตัวเลือกที่สามารถตั้งค่าในฟังก์ชัน HTTPS ที่เรียกใช้ได้ |
CallableRequest | คำขอที่ใช้เรียกฟังก์ชันที่เรียกใช้ได้ |
ตัวเลือก HTTP | ตัวเลือกที่ตั้งค่าได้ในฟังก์ชัน HTTPS onRequest |
คำขอ | คำขอด่วนที่มีรูปแบบการสื่อสารของเนื้อหาคำขอ |
พิมพ์ชื่อแทน
พิมพ์ชื่อแทน | คำอธิบาย |
---|---|
FunctionsErrorCode | ชุดรหัสสถานะฟังก์ชัน Firebase รหัสจะเหมือนกันกับรหัสที่ gRPC เห็น |
HttpsFunction | จัดการคำขอ HTTPS |
https.onCall()
ประกาศเมธอดที่เรียกใช้ได้เพื่อให้ลูกค้าเรียกใช้ได้โดยใช้ Firebase SDK
ลายเซ็น:
export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือกการโทร | ตัวเลือกที่จะตั้งค่าในฟังก์ชันนี้ |
ตัวแฮนเดิล | (คำขอ: CallableRequest<T>) => ย้อนกลับ | ฟังก์ชันที่ใช้ https.CallableRequest |
การคืนสินค้า:
CallableFunction<T, ย้อนกลับ>
ฟังก์ชันที่คุณส่งออกและทำให้ใช้งานได้ได้
https.onCall()
ประกาศเมธอดที่เรียกใช้ได้เพื่อให้ลูกค้าเรียกใช้ได้โดยใช้ Firebase SDK
ลายเซ็น:
export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวแฮนเดิล | (คำขอ: CallableRequest<T>) => ย้อนกลับ | ฟังก์ชันที่ใช้ https.CallableRequest |
การคืนสินค้า:
CallableFunction<T, ย้อนกลับ>
ฟังก์ชันที่คุณส่งออกและทำให้ใช้งานได้ได้
https.onRequest()
จัดการคำขอ HTTPS
ลายเซ็น:
export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือก HTTP | ตัวเลือกที่จะตั้งค่าในฟังก์ชันนี้ |
ตัวแฮนเดิล | (request: Request, Response: express.Response) => เป็นโมฆะ | คำมั่นสัญญา<โมฆะ> | ฟังก์ชันที่ใช้ https.Request และออบเจ็กต์การตอบกลับ ซึ่งเป็นลายเซ็นเดียวกับแอป Express |
การคืนสินค้า:
ฟังก์ชันที่คุณส่งออกและทำให้ใช้งานได้ได้
https.onRequest()
จัดการคำขอ HTTPS
ลายเซ็น:
export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวแฮนเดิล | (request: Request, Response: express.Response) => เป็นโมฆะ | คำมั่นสัญญา<โมฆะ> | ฟังก์ชันที่ใช้ https.Request และออบเจ็กต์การตอบกลับ ซึ่งเป็นลายเซ็นเดียวกันกับแอป 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
: ไม่พร้อมให้บริการในขณะนี้ ปัญหานี้อาจเกิดขึ้นชั่วคราวและอาจแก้ไขได้โดยการลองอีกครั้งโดยใช้ Backoffdata-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";
https.HttpsFunction
จัดการคำขอ HTTPS
ลายเซ็น:
export type HttpsFunction = ((
req: Request,
res: express.Response) => void | Promise<void>) & {
__trigger?: unknown;
__endpoint: ManifestEndpoint;
};