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