ฟังก์ชั่นคลาวด์สำหรับ Firebase
ฟังก์ชั่น
| การทำงาน | คำอธิบาย |
|---|---|
| ฟังก์ชั่น(แอพ, ...) | |
| getFunctions (แอป ภูมิภาคหรือโดเมนที่กำหนดเอง) | ส่งคืนอินสแตนซ์ ฟังก์ชัน สำหรับแอปที่กำหนด |
| ฟังก์ชัน(functionsInstance, ...) | |
| เชื่อมต่อฟังก์ชั่นอีมูเลเตอร์ (ฟังก์ชั่นอินสแตนซ์, โฮสต์, พอร์ต) | แก้ไขอินสแตนซ์นี้เพื่อสื่อสารกับโปรแกรมจำลอง Cloud Functions หมายเหตุ: ต้องถูกเรียกก่อนที่จะใช้อินสแตนซ์นี้ในการดำเนินการใดๆ |
| httpsCallable (ฟังก์ชันอินสแตนซ์ ชื่อ ตัวเลือก) | ส่งคืนการอ้างอิงไปยังทริกเกอร์ HTTPS ที่เรียกใช้ได้พร้อมชื่อที่กำหนด |
| httpsCallableFromURL (ฟังก์ชั่นอินสแตนซ์, url, ตัวเลือก) | ส่งคืนการอ้างอิงไปยังทริกเกอร์ HTTPS ที่สามารถเรียกได้ด้วย URL ที่ระบุ |
อินเทอร์เฟซ
| อินเตอร์เฟซ | คำอธิบาย |
|---|---|
| ฟังก์ชั่น | อินสแตนซ์ของ Functions |
| ฟังก์ชั่นข้อผิดพลาด | ข้อผิดพลาดที่ส่งคืนโดย SDK ไคลเอ็นต์ฟังก์ชัน Firebase |
| HttpsCallableOptions | อินเทอร์เฟซสำหรับข้อมูลเมตาเกี่ยวกับวิธีการดำเนินการโทร |
| HttpsCallableResult | HttpsCallableResult ตัดผลลัพธ์เดียวจากการเรียกใช้ฟังก์ชัน |
พิมพ์นามแฝง
| พิมพ์นามแฝง | คำอธิบาย |
|---|---|
| ฟังก์ชั่นรหัสข้อผิดพลาด | ชุดรหัสสถานะฟังก์ชัน Firebase รหัสเหมือนกันกับรหัสที่ gRPC เปิดเผยที่นี่: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md ค่าที่เป็นไปได้: - 'ยกเลิก': การดำเนินการถูกยกเลิก (โดยทั่วไปโดยผู้โทร) - 'unknown': ข้อผิดพลาดที่ไม่รู้จักหรือข้อผิดพลาดจากโดเมนข้อผิดพลาดอื่น - 'invalid-argument': ลูกค้าระบุอาร์กิวเมนต์ที่ไม่ถูกต้อง โปรดทราบว่าสิ่งนี้แตกต่างจาก 'เงื่อนไขที่ล้มเหลว' 'อาร์กิวเมนต์ที่ไม่ถูกต้อง' บ่งชี้ถึงอาร์กิวเมนต์ที่เป็นปัญหาโดยไม่คำนึงถึงสถานะของระบบ (เช่นชื่อฟิลด์ที่ไม่ถูกต้อง) - 'deadline-exceeded': กำหนดเวลาสิ้นสุดก่อนที่การดำเนินการจะเสร็จสมบูรณ์ สำหรับการดำเนินการที่เปลี่ยนสถานะของระบบ ข้อผิดพลาดนี้อาจถูกส่งกลับแม้ว่าการดำเนินการจะเสร็จสมบูรณ์แล้วก็ตาม ตัวอย่างเช่น การตอบกลับที่สำเร็จจากเซิร์ฟเวอร์อาจมีความล่าช้านานพอที่จะหมดกำหนดเวลา - 'ไม่พบ': ไม่พบเอกสารที่ร้องขอบางรายการ - 'มีอยู่แล้ว': เอกสารบางรายการที่เราพยายามสร้างมีอยู่แล้ว - 'permission-denied': ผู้เรียกไม่ได้รับอนุญาตให้ดำเนินการตามที่ระบุ - 'ทรัพยากรหมด': ทรัพยากรบางส่วนหมดลง อาจเป็นโควต้าต่อผู้ใช้ หรือบางทีระบบไฟล์ทั้งหมดไม่มีพื้นที่เหลือ - 'failed-precondition': การดำเนินการถูกปฏิเสธเนื่องจากระบบไม่อยู่ในสถานะที่จำเป็นสำหรับการดำเนินการของการดำเนินการ - 'ยกเลิก': การดำเนินการถูกยกเลิก โดยทั่วไปเนื่องจากปัญหาการทำงานพร้อมกัน เช่น การยกเลิกธุรกรรม ฯลฯ - 'อยู่นอกขอบเขต': มีความพยายามดำเนินการเกินช่วงที่ถูกต้อง - 'ไม่ได้ใช้งาน': การดำเนินการไม่ได้รับการใช้งานหรือไม่รองรับ/เปิดใช้งาน - 'ภายใน': ข้อผิดพลาดภายใน หมายความว่าค่าคงที่บางตัวที่คาดไว้โดยระบบพื้นฐานนั้นเสียหาย หากคุณเห็นข้อผิดพลาดข้อใดข้อหนึ่ง แสดงว่ามีบางอย่างเสียหายมาก - 'ไม่พร้อมใช้งาน': บริการไม่พร้อมใช้งานในขณะนี้ นี่น่าจะเป็นสภาวะชั่วคราวและอาจแก้ไขได้ด้วยการลองย้อนกลับอีกครั้ง - 'ข้อมูลสูญหาย': ข้อมูลสูญหายหรือเสียหายที่ไม่สามารถกู้คืนได้ - 'ไม่ได้รับการรับรองความถูกต้อง': คำขอไม่มีข้อมูลรับรองการตรวจสอบความถูกต้องที่ถูกต้องสำหรับการดำเนินการ |
| ฟังก์ชันErrorCodeCore | สตริงรหัสข้อผิดพลาดของฟังก์ชันต่อท้ายหลังคำนำหน้าผลิตภัณฑ์ "functions/" ดู FunctionsErrorCode สำหรับเอกสารรหัสฉบับเต็ม |
| HttpsCallable | การอ้างอิงถึงทริกเกอร์ HTTP "ที่เรียกได้" ในฟังก์ชัน Google Cloud |
ฟังก์ชั่น(แอพ, ...)
getFunctions (แอป ภูมิภาคหรือโดเมนที่กำหนดเอง)
ส่งคืนอินสแตนซ์ ฟังก์ชัน สำหรับแอปที่กำหนด
ลายเซ็น:
export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| แอป | แอป Firebase | FirebaseApp ที่จะใช้ |
| ภูมิภาคหรือโดเมนแบบกำหนดเอง | เชือก | หนึ่งใน: a) ภูมิภาคที่ฟังก์ชันที่เรียกได้ตั้งอยู่ (เช่น: us-central1) b) โดเมนแบบกำหนดเองที่โฮสต์ฟังก์ชันที่เรียกได้ (เช่น: https://mydomain.com) |
ผลตอบแทน:
ฟังก์ชัน(functionsInstance, ...)
เชื่อมต่อฟังก์ชั่นอีมูเลเตอร์ (ฟังก์ชั่นอินสแตนซ์, โฮสต์, พอร์ต)
แก้ไขอินสแตนซ์นี้เพื่อสื่อสารกับโปรแกรมจำลอง Cloud Functions
ลายเซ็น:
export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ฟังก์ชั่นอินสแตนซ์ | ฟังก์ชั่น | |
| เจ้าภาพ | เชือก | โฮสต์โปรแกรมจำลอง (เช่น: localhost) |
| ท่าเรือ | ตัวเลข | พอร์ตจำลอง (เช่น 5001) |
ผลตอบแทน:
เป็นโมฆะ
httpsCallable (ฟังก์ชันอินสแตนซ์ ชื่อ ตัวเลือก)
ส่งคืนการอ้างอิงไปยังทริกเกอร์ HTTPS ที่เรียกใช้ได้พร้อมชื่อที่กำหนด
ลายเซ็น:
export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ฟังก์ชั่นอินสแตนซ์ | ฟังก์ชั่น | |
| ชื่อ | เชือก | ชื่อของทริกเกอร์ |
| ตัวเลือก | HttpsCallableOptions |
ผลตอบแทน:
HttpsCallable <RequestData, ResponseData>
httpsCallableFromURL (ฟังก์ชั่นอินสแตนซ์, url, ตัวเลือก)
ส่งคืนการอ้างอิงไปยังทริกเกอร์ HTTPS ที่สามารถเรียกได้ด้วย URL ที่ระบุ
ลายเซ็น:
export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ฟังก์ชั่นอินสแตนซ์ | ฟังก์ชั่น | |
| URL | เชือก | URL ของทริกเกอร์ |
| ตัวเลือก | HttpsCallableOptions |
ผลตอบแทน:
HttpsCallable <RequestData, ResponseData>
ฟังก์ชั่นรหัสข้อผิดพลาด
ชุดรหัสสถานะฟังก์ชัน Firebase รหัสเหมือนกันกับรหัสที่ gRPC เปิดเผยที่นี่: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
ค่าที่เป็นไปได้: - 'ยกเลิก': การดำเนินการถูกยกเลิก (โดยทั่วไปโดยผู้โทร) - 'unknown': ข้อผิดพลาดที่ไม่รู้จักหรือข้อผิดพลาดจากโดเมนข้อผิดพลาดอื่น - 'invalid-argument': ลูกค้าระบุอาร์กิวเมนต์ที่ไม่ถูกต้อง โปรดทราบว่าสิ่งนี้แตกต่างจาก 'เงื่อนไขที่ล้มเหลว' 'อาร์กิวเมนต์ที่ไม่ถูกต้อง' บ่งชี้ถึงอาร์กิวเมนต์ที่เป็นปัญหาโดยไม่คำนึงถึงสถานะของระบบ (เช่นชื่อฟิลด์ที่ไม่ถูกต้อง) - 'deadline-exceeded': กำหนดเวลาสิ้นสุดก่อนที่การดำเนินการจะเสร็จสมบูรณ์ สำหรับการดำเนินการที่เปลี่ยนสถานะของระบบ ข้อผิดพลาดนี้อาจถูกส่งกลับแม้ว่าการดำเนินการจะเสร็จสมบูรณ์แล้วก็ตาม ตัวอย่างเช่น การตอบกลับที่สำเร็จจากเซิร์ฟเวอร์อาจมีความล่าช้านานพอที่จะหมดกำหนดเวลา - 'ไม่พบ': ไม่พบเอกสารที่ร้องขอบางรายการ - 'มีอยู่แล้ว': เอกสารบางรายการที่เราพยายามสร้างมีอยู่แล้ว - 'permission-denied': ผู้เรียกไม่ได้รับอนุญาตให้ดำเนินการตามที่ระบุ - 'ทรัพยากรหมด': ทรัพยากรบางส่วนหมดลง อาจเป็นโควต้าต่อผู้ใช้ หรือบางทีระบบไฟล์ทั้งหมดไม่มีพื้นที่เหลือ - 'failed-precondition': การดำเนินการถูกปฏิเสธเนื่องจากระบบไม่อยู่ในสถานะที่จำเป็นสำหรับการดำเนินการของการดำเนินการ - 'ยกเลิก': การดำเนินการถูกยกเลิก โดยทั่วไปเนื่องจากปัญหาการทำงานพร้อมกัน เช่น การยกเลิกธุรกรรม ฯลฯ - 'อยู่นอกขอบเขต': มีความพยายามดำเนินการเกินช่วงที่ถูกต้อง - 'ไม่ได้ใช้งาน': การดำเนินการไม่ได้รับการใช้งานหรือไม่รองรับ/เปิดใช้งาน - 'ภายใน': ข้อผิดพลาดภายใน หมายความว่าค่าคงที่บางตัวที่คาดไว้โดยระบบพื้นฐานนั้นเสียหาย หากคุณเห็นข้อผิดพลาดข้อใดข้อหนึ่ง แสดงว่ามีบางอย่างเสียหายมาก - 'ไม่พร้อมใช้งาน': บริการไม่พร้อมใช้งานในขณะนี้ นี่น่าจะเป็นสภาวะชั่วคราวและอาจแก้ไขได้ด้วยการลองย้อนกลับอีกครั้ง - 'ข้อมูลสูญหาย': ข้อมูลสูญหายหรือเสียหายที่ไม่สามารถกู้คืนได้ - 'ไม่ได้รับการรับรองความถูกต้อง': คำขอไม่มีข้อมูลรับรองการตรวจสอบความถูกต้องที่ถูกต้องสำหรับการดำเนินการ
ลายเซ็น:
export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
ฟังก์ชันErrorCodeCore
สตริงรหัสข้อผิดพลาดของฟังก์ชันต่อท้ายหลังคำนำหน้าผลิตภัณฑ์ "functions/" ดู FunctionsErrorCode สำหรับเอกสารรหัสฉบับเต็ม
ลายเซ็น:
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
การอ้างอิงถึงทริกเกอร์ HTTP "ที่เรียกได้" ในฟังก์ชัน Google Cloud
ลายเซ็น:
export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;