https namespace

ฟังก์ชั่น

การทำงาน คำอธิบาย
onCall (ตัวเลือก ตัวจัดการ) ประกาศวิธีการที่เรียกได้เพื่อให้ไคลเอ็นต์โทรโดยใช้ Firebase SDK
onCall (ตัวจัดการ) ประกาศวิธีการที่เรียกได้เพื่อให้ไคลเอ็นต์โทรโดยใช้ Firebase SDK
onRequest (ตัวเลือก ตัวจัดการ) จัดการคำขอ HTTPS
onRequest (ตัวจัดการ) จัดการคำขอ HTTPS

ชั้นเรียน

ระดับ คำอธิบาย
HttpsError ข้อผิดพลาดที่ชัดเจนที่สามารถส่งจากตัวจัดการเพื่อส่งข้อผิดพลาดไปยังไคลเอนต์ที่เรียกว่าฟังก์ชัน

อินเทอร์เฟซ

อินเตอร์เฟซ คำอธิบาย
CallableFunction สร้างวิธีการที่เรียกได้เพื่อให้ไคลเอ็นต์โทรโดยใช้ Firebase SDK
CallableOptions ตัวเลือกที่สามารถตั้งค่าบนฟังก์ชัน HTTPS ที่สามารถเรียกได้
CallableRequest คำขอที่ใช้ในการเรียกใช้ฟังก์ชันที่เรียกได้
HttpsOptions ตัวเลือกที่สามารถตั้งค่าได้ในฟังก์ชัน onRequest HTTPS
ขอ คำขอด่วนพร้อมการแสดงรูปแบบเส้นลวดของเนื้อหาคำขอ

พิมพ์นามแฝง

พิมพ์นามแฝง คำอธิบาย
ฟังก์ชั่นรหัสข้อผิดพลาด ชุดรหัสสถานะฟังก์ชัน 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>;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
เลือก CallableOptions ตัวเลือกในการตั้งค่าฟังก์ชั่นนี้
ตัวจัดการ (คำขอ: 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;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
เลือก HttpsOptions ตัวเลือกในการตั้งค่าฟังก์ชั่นนี้
ตัวจัดการ (คำขอ: คำขอ , การตอบสนอง: express.Response) => เป็นโมฆะ | สัญญา<โมฆะ> ฟังก์ชันที่ใช้ออบเจ็กต์ https.Request และการตอบสนอง ซึ่งเป็นลายเซ็นเดียวกับแอป Express

ผลตอบแทน:

HttpsFunction

ฟังก์ชันที่คุณสามารถส่งออกและปรับใช้ได้

https.onRequest()

จัดการคำขอ HTTPS

ลายเซ็น:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
ตัวจัดการ (คำขอ: คำขอ , การตอบสนอง: express.Response) => เป็นโมฆะ | สัญญา<โมฆะ> ฟังก์ชันที่ใช้ออบเจ็กต์ https.Request และการตอบสนอง ซึ่งเป็นลายเซ็นเดียวกับแอป Express

ผลตอบแทน:

HttpsFunction

ฟังก์ชันที่คุณสามารถส่งออกและปรับใช้ได้

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

https.HttpsFunction

จัดการคำขอ HTTPS

ลายเซ็น:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};