ที่เก็บข้อมูลบนคลาวด์สำหรับ Firebase
ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
ฟังก์ชั่น(แอพ, ...) | |
getStorage (แอป, bucketUrl) | รับอินสแตนซ์ FirebaseStorage สำหรับแอป Firebase ที่ระบุ |
ฟังก์ชั่น(ที่เก็บข้อมูล, ...) | |
ConnectStorageEmulator (ที่เก็บข้อมูล โฮสต์ พอร์ต ตัวเลือก) | แก้ไขอินสแตนซ์ FirebaseStorage นี้เพื่อสื่อสารกับโปรแกรมจำลอง Cloud Storage |
ref(ที่เก็บข้อมูล, url) | ส่งคืน StorageReference สำหรับ URL ที่กำหนด |
ฟังก์ชั่น(อ้างอิง, ...) | |
ลบวัตถุ(อ้างอิง) | ลบวัตถุที่ตำแหน่งนี้ |
getBlob (อ้างอิง, maxDownloadSizeBytes) | ดาวน์โหลดข้อมูลที่ตำแหน่งของวัตถุ ส่งกลับข้อผิดพลาดหากไม่พบวัตถุ หากต้องการใช้ฟังก์ชันนี้ คุณต้องอนุญาตต้นทางของแอปในที่เก็บข้อมูล Cloud Storage เป็นพิเศษ ดูเพิ่มเติมที่https://cloud.google.com/storage/docs/configuring-cors API นี้ไม่พร้อมใช้งานใน Node. |
getBytes (อ้างอิง, maxDownloadSizeBytes) | ดาวน์โหลดข้อมูลที่ตำแหน่งของวัตถุ ส่งกลับข้อผิดพลาดหากไม่พบวัตถุ หากต้องการใช้ฟังก์ชันนี้ คุณต้องอนุญาตต้นทางของแอปในที่เก็บข้อมูล Cloud Storage เป็นพิเศษ ดูเพิ่มเติมที่https://cloud.google.com/storage/docs/configuring-cors |
getDownloadURL(อ้างอิง) | ส่งกลับ URL ดาวน์โหลดสำหรับ StorageReference ที่กำหนด . |
getMetadata (อ้างอิง) | Promise ที่แก้ไขได้ด้วยข้อมูลเมตาสำหรับออบเจ็กต์นี้ หากไม่มีออบเจ็กต์นี้หรือไม่สามารถเรียกข้อมูลเมตาได้ สัญญาจะถูกปฏิเสธ |
getStream (อ้างอิง, maxDownloadSizeBytes) | ดาวน์โหลดข้อมูลที่ตำแหน่งของวัตถุ ทำให้เกิดเหตุการณ์ข้อผิดพลาดหากไม่พบวัตถุ API นี้มีเฉพาะใน Node. |
รายการ (อ้างอิง ตัวเลือก) | รายการ (ไฟล์) และคำนำหน้า (โฟลเดอร์) ภายใต้การอ้างอิงที่เก็บข้อมูลนี้ List API ใช้ได้กับกฎ Firebase เวอร์ชัน 2 เท่านั้น GCS เป็นร้านค้าคีย์หยด Firebase Storage กำหนดความหมายของโครงสร้างโฟลเดอร์ที่คั่นด้วย '/' โปรดดูรายการ API ของ GCS หากคุณต้องการเรียนรู้เพิ่มเติม เพื่อให้เป็นไปตามซีแมนทิกส์ของกฎ Firebase นั้น Firebase Storage จะไม่รองรับออบเจ็กต์ที่มีเส้นทางลงท้ายด้วย "/" หรือมี "/" สองตัวติดต่อกัน Firebase Storage List API จะกรองออบเจ็กต์ที่ไม่รองรับเหล่านี้ list() อาจล้มเหลวหากมีวัตถุที่ไม่รองรับในที่เก็บข้อมูลมากเกินไป |
รายการทั้งหมด(อ้างอิง) | แสดงรายการทั้งหมด (ไฟล์) และคำนำหน้า (โฟลเดอร์) ภายใต้การอ้างอิงที่เก็บข้อมูลนี้ นี่เป็นวิธีการช่วยเหลือในการเรียก list() ซ้ำๆ กันจนกระทั่งไม่มีผลลัพธ์อีกต่อไป ขนาดการแบ่งหน้าเริ่มต้นคือ 1000 หมายเหตุ: ผลลัพธ์อาจไม่สอดคล้องกันหากวัตถุมีการเปลี่ยนแปลงในขณะที่การดำเนินการนี้กำลังทำงานอยู่ คำเตือน: listAll อาจใช้ทรัพยากรมากเกินไปหากมีผลลัพธ์มากเกินไป |
updateMetadata (อ้างอิง ข้อมูลเมตา) | อัพเดตข้อมูลเมตาสำหรับออบเจ็กต์นี้ |
uploadBytes (อ้างอิง ข้อมูล เมตาดาต้า) | อัปโหลดข้อมูลไปยังตำแหน่งของวัตถุนี้ การอัปโหลดไม่สามารถดำเนินการต่อได้ |
uploadBytesResumable (อ้างอิง ข้อมูล เมตาดาต้า) | อัปโหลดข้อมูลไปยังตำแหน่งของวัตถุนี้ การอัปโหลดสามารถหยุดชั่วคราวและดำเนินการต่อได้ และเปิดเผยการอัปเดตความคืบหน้า |
uploadString(อ้างอิง ค่า รูปแบบ ข้อมูลเมตา) | อัปโหลดสตริงไปยังตำแหน่งของวัตถุนี้ การอัปโหลดไม่สามารถดำเนินการต่อได้ |
ฟังก์ชั่น (storageOrRef, ...) | |
อ้างอิง (storageOrRef, เส้นทาง) | ส่งคืน StorageReference สำหรับเส้นทางที่กำหนดในที่เก็บข้อมูลเริ่มต้น |
ชั้นเรียน
ระดับ | คำอธิบาย |
---|---|
ข้อผิดพลาดในการจัดเก็บ | ข้อผิดพลาดที่ส่งคืนโดย Firebase Storage SDK |
การแจงนับ
การแจกแจง | คำอธิบาย |
---|---|
รหัสข้อผิดพลาดในการจัดเก็บ | รหัสข้อผิดพลาดที่สามารถแนบไปกับออบเจ็กต์ StorageError |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
FirebaseStorage | อินสแตนซ์ Firebase Storage |
ข้อมูลเมตาแบบเต็ม | ชุดข้อมูลเมตาของออบเจ็กต์แบบเต็ม รวมถึงคุณสมบัติแบบอ่านอย่างเดียว |
รายการตัวเลือก | list() ยอมรับ |
รายการผลลัพธ์ | ผลลัพธ์ที่ส่งคืนโดย list() |
Metadata ที่สามารถตั้งค่าได้ | ข้อมูลเมตาของออบเจ็กต์ที่สามารถตั้งค่าได้ตลอดเวลา |
ผู้สังเกตการณ์การจัดเก็บข้อมูล | ผู้สังเกตการณ์สตรีมสำหรับ Firebase Storage |
การอ้างอิงการจัดเก็บข้อมูล | แสดงถึงการอ้างอิงถึงวัตถุ Google Cloud Storage นักพัฒนาสามารถอัปโหลด ดาวน์โหลด และลบออบเจ็กต์ รวมถึงรับ/ตั้งค่าข้อมูลเมตาของออบเจ็กต์ได้ |
อัปโหลดข้อมูลเมตา | ข้อมูลเมตาของออบเจ็กต์ที่สามารถตั้งค่าได้เมื่ออัปโหลด |
อัพโหลดผลลัพธ์ | ผลลัพธ์ที่ส่งคืนจากการอัปโหลดที่ไม่สามารถดำเนินการต่อได้ |
อัพโหลดTask | แสดงถึงกระบวนการอัพโหลดวัตถุ ช่วยให้คุณตรวจสอบและจัดการการอัปโหลด |
อัพโหลด TaskSnapshot | เก็บข้อมูลเกี่ยวกับสถานะปัจจุบันของงานอัพโหลด |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
รูปแบบสตริง | การแจงนับรูปแบบสตริงที่เป็นไปได้สำหรับการอัปโหลด |
พิมพ์นามแฝง
พิมพ์นามแฝง | คำอธิบาย |
---|---|
StringFormat | การแจงนับรูปแบบสตริงที่เป็นไปได้สำหรับการอัปโหลด |
งานกิจกรรม | เหตุการณ์ที่ถูกทริกเกอร์ในงาน |
สถานะงาน | แสดงถึงสถานะปัจจุบันของการอัปโหลดที่ทำงานอยู่ |
ฟังก์ชั่น(แอพ, ...)
getStorage (แอป, bucketUrl)
รับอินสแตนซ์ FirebaseStorage สำหรับแอป Firebase ที่ระบุ
ลายเซ็น:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอป | แอป Firebase | แอป Firebase เพื่อรับอินสแตนซ์ FirebaseStorage |
bucketUrl | เชือก | gs:// url ไปยัง Firebase Storage Bucket ของคุณ หากไม่ผ่าน ให้ใช้ Storage Bucket เริ่มต้นของแอป |
ผลตอบแทน:
อินสแตนซ์ FirebaseStorage
ฟังก์ชั่น(ที่เก็บข้อมูล, ...)
ConnectStorageEmulator (ที่เก็บข้อมูล โฮสต์ พอร์ต ตัวเลือก)
แก้ไขอินสแตนซ์ FirebaseStorage นี้เพื่อสื่อสารกับโปรแกรมจำลอง Cloud Storage
ลายเซ็น:
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
พื้นที่จัดเก็บ | FirebaseStorage | อินสแตนซ์ FirebaseStorage |
เจ้าภาพ | เชือก | โฮสต์โปรแกรมจำลอง (เช่น: localhost) |
ท่าเรือ | ตัวเลข | พอร์ตจำลอง (เช่น 5001) |
ตัวเลือก | { mockUserToken?: EmulatorMockTokenOptions | เชือก; } | ตัวเลือกโปรแกรมจำลอง options.mockUserToken เป็นโทเค็นการตรวจสอบสิทธิ์จำลองเพื่อใช้สำหรับการทดสอบกฎความปลอดภัยหน่วย |
ผลตอบแทน:
เป็นโมฆะ
ref(ที่เก็บข้อมูล, url)
ส่งคืน StorageReference สำหรับ URL ที่กำหนด
ลายเซ็น:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
พื้นที่จัดเก็บ | FirebaseStorage | อินสแตนซ์ FirebaseStorage |
URL | เชือก | URL หากว่างเปล่า จะส่งคืนการอ้างอิงรูท |
ผลตอบแทน:
ฟังก์ชั่น(อ้างอิง, ...)
ลบวัตถุ(อ้างอิง)
ลบวัตถุที่ตำแหน่งนี้
ลายเซ็น:
export declare function deleteObject(ref: StorageReference): Promise<void>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference สำหรับวัตถุที่จะลบ |
ผลตอบแทน:
สัญญา<โมฆะ>
Promise
ที่จะแก้ไขได้หากการลบสำเร็จ
getBlob (อ้างอิง, maxDownloadSizeBytes)
ดาวน์โหลดข้อมูลที่ตำแหน่งของวัตถุ ส่งกลับข้อผิดพลาดหากไม่พบวัตถุ
หากต้องการใช้ฟังก์ชันนี้ คุณต้องอนุญาตต้นทางของแอปในที่เก็บข้อมูล Cloud Storage เป็นพิเศษ ดูเพิ่มเติมที่https://cloud.google.com/storage/docs/configuring-cors
API นี้ไม่พร้อมใช้งานใน Node.
ลายเซ็น:
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | Storageอ้างอิงตำแหน่งที่ควรดาวน์โหลดข้อมูล |
maxDownloadSizeBytes | ตัวเลข | หากตั้งค่าไว้ ขนาดสูงสุดที่อนุญาตเป็นไบต์ในการดึงข้อมูล |
ผลตอบแทน:
สัญญา<หยด>
สัญญาที่แก้ไขได้ด้วย Blob ที่มีไบต์ของวัตถุ
getBytes (อ้างอิง, maxDownloadSizeBytes)
ดาวน์โหลดข้อมูลที่ตำแหน่งของวัตถุ ส่งกลับข้อผิดพลาดหากไม่พบวัตถุ
หากต้องการใช้ฟังก์ชันนี้ คุณต้องอนุญาตต้นทางของแอปในที่เก็บข้อมูล Cloud Storage เป็นพิเศษ ดูเพิ่มเติมที่https://cloud.google.com/storage/docs/configuring-cors
ลายเซ็น:
export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | Storageอ้างอิงตำแหน่งที่ควรดาวน์โหลดข้อมูล |
maxDownloadSizeBytes | ตัวเลข | หากตั้งค่าไว้ ขนาดสูงสุดที่อนุญาตเป็นไบต์ในการดึงข้อมูล |
ผลตอบแทน:
สัญญา <ArrayBuffer>
สัญญาที่มีไบต์ของวัตถุ
getDownloadURL(อ้างอิง)
ส่งกลับ URL ดาวน์โหลดสำหรับ StorageReference ที่กำหนด .
ลายเซ็น:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference เพื่อรับ URL ดาวน์โหลด |
ผลตอบแทน:
สัญญา<สตริง>
Promise
ที่แก้ไขได้ด้วย URL ดาวน์โหลดสำหรับออบเจ็กต์นี้
getMetadata (อ้างอิง)
Promise
ที่แก้ไขได้ด้วยข้อมูลเมตาสำหรับออบเจ็กต์นี้ หากไม่มีออบเจ็กต์นี้หรือไม่สามารถเรียกข้อมูลเมตาได้ สัญญาจะถูกปฏิเสธ
ลายเซ็น:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference เพื่อรับข้อมูลเมตาจาก |
ผลตอบแทน:
สัญญา < FullMetadata >
getStream (อ้างอิง, maxDownloadSizeBytes)
ดาวน์โหลดข้อมูลที่ตำแหน่งของวัตถุ ทำให้เกิดเหตุการณ์ข้อผิดพลาดหากไม่พบวัตถุ
API นี้มีเฉพาะใน Node.
ลายเซ็น:
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | Storageอ้างอิงตำแหน่งที่ควรดาวน์โหลดข้อมูล |
maxDownloadSizeBytes | ตัวเลข | หากตั้งค่าไว้ ขนาดสูงสุดที่อนุญาตเป็นไบต์ในการดึงข้อมูล |
ผลตอบแทน:
NodeJS.ReadableStream
สตรีมที่มีข้อมูลของวัตถุเป็นไบต์
รายการ (อ้างอิง ตัวเลือก)
รายการ (ไฟล์) และคำนำหน้า (โฟลเดอร์) ภายใต้การอ้างอิงที่เก็บข้อมูลนี้
List API ใช้ได้กับกฎ Firebase เวอร์ชัน 2 เท่านั้น
GCS เป็นร้านค้าคีย์หยด Firebase Storage กำหนดความหมายของโครงสร้างโฟลเดอร์ที่คั่นด้วย '/' โปรดดูรายการ API ของ GCS หากคุณต้องการเรียนรู้เพิ่มเติม
เพื่อให้เป็นไปตามซีแมนทิกส์ของกฎ Firebase นั้น Firebase Storage จะไม่รองรับออบเจ็กต์ที่มีเส้นทางลงท้ายด้วย "/" หรือมี "/" สองตัวติดต่อกัน Firebase Storage List API จะกรองออบเจ็กต์ที่ไม่รองรับเหล่านี้ list() อาจล้มเหลวหากมีวัตถุที่ไม่รองรับในที่เก็บข้อมูลมากเกินไป
ลายเซ็น:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference เพื่อรับรายการ |
ตัวเลือก | รายการตัวเลือก | ดู ListOptions สำหรับรายละเอียด |
ผลตอบแทน:
สัญญา < ListResult >
Promise
ที่แก้ไขได้ด้วยรายการและคำนำหน้า prefixes
มีการอ้างอิงถึงโฟลเดอร์ย่อยและ items
มีการอ้างอิงถึงออบเจ็กต์ในโฟลเดอร์นี้ nextPageToken
สามารถใช้เพื่อรับผลลัพธ์ที่เหลือ
รายการทั้งหมด(อ้างอิง)
แสดงรายการทั้งหมด (ไฟล์) และคำนำหน้า (โฟลเดอร์) ภายใต้การอ้างอิงที่เก็บข้อมูลนี้
นี่เป็นวิธีการช่วยเหลือในการเรียก list() ซ้ำๆ กันจนกระทั่งไม่มีผลลัพธ์อีกต่อไป ขนาดการแบ่งหน้าเริ่มต้นคือ 1000
ลายเซ็น:
export declare function listAll(ref: StorageReference): Promise<ListResult>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference เพื่อรับรายการ |
ผลตอบแทน:
สัญญา < ListResult >
Promise
ที่แก้ไขได้ด้วยรายการและคำนำหน้าทั้งหมดภายใต้การอ้างอิงที่เก็บข้อมูลปัจจุบัน prefixes
มีการอ้างอิงถึงไดเร็กทอรีย่อยและ items
มีการอ้างอิงถึงออบเจ็กต์ในโฟลเดอร์นี้ nextPageToken
จะไม่ถูกส่งคืน
updateMetadata (อ้างอิง ข้อมูลเมตา)
อัพเดตข้อมูลเมตาสำหรับออบเจ็กต์นี้
ลายเซ็น:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference เพื่ออัปเดตข้อมูลเมตาสำหรับ |
ข้อมูลเมตา | Metadata ที่สามารถตั้งค่าได้ | ข้อมูลเมตาใหม่สำหรับออบเจ็กต์ เฉพาะค่าที่ได้รับการตั้งค่าไว้อย่างชัดเจนเท่านั้นที่จะถูกเปลี่ยนแปลง การตั้งค่าเป็น null อย่างชัดเจนจะลบข้อมูลเมตา |
ผลตอบแทน:
สัญญา < FullMetadata >
Promise
ที่แก้ไขได้ด้วยข้อมูลเมตาใหม่สำหรับออบเจ็กต์นี้
uploadBytes (อ้างอิง ข้อมูล เมตาดาต้า)
อัปโหลดข้อมูลไปยังตำแหน่งของวัตถุนี้ การอัปโหลดไม่สามารถดำเนินการต่อได้
ลายเซ็น:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | Storageอ้างอิง ตำแหน่งที่ควรอัปโหลดข้อมูล |
ข้อมูล | หยด | Uint8Array | อาร์เรย์บัฟเฟอร์ | ข้อมูลที่จะอัปโหลด |
ข้อมูลเมตา | อัปโหลดข้อมูลเมตา | ข้อมูลเมตาสำหรับข้อมูลที่จะอัปโหลด |
ผลตอบแทน:
สัญญา < อัพโหลดผลลัพธ์ >
คำสัญญาที่มี UploadResult
uploadBytesResumable (อ้างอิง ข้อมูล เมตาดาต้า)
อัปโหลดข้อมูลไปยังตำแหน่งของวัตถุนี้ การอัปโหลดสามารถหยุดชั่วคราวและดำเนินการต่อได้ และเปิดเผยการอัปเดตความคืบหน้า
ลายเซ็น:
export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | Storageอ้างอิง ตำแหน่งที่ควรอัปโหลดข้อมูล |
ข้อมูล | หยด | Uint8Array | อาร์เรย์บัฟเฟอร์ | ข้อมูลที่จะอัปโหลด |
ข้อมูลเมตา | อัปโหลดข้อมูลเมตา | ข้อมูลเมตาสำหรับข้อมูลที่จะอัปโหลด |
ผลตอบแทน:
งานอัพโหลด
uploadString(อ้างอิง ค่า รูปแบบ ข้อมูลเมตา)
อัปโหลดสตริงไปยังตำแหน่งของวัตถุนี้ การอัปโหลดไม่สามารถดำเนินการต่อได้
ลายเซ็น:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
อ้างอิง | การอ้างอิงการจัดเก็บข้อมูล | StorageReference ที่ควรอัปโหลดสตริง |
ค่า | เชือก | สตริงที่จะอัปโหลด |
รูปแบบ | รูปแบบสตริง | รูปแบบของสตริงที่จะอัปโหลด |
ข้อมูลเมตา | อัปโหลดข้อมูลเมตา | ข้อมูลเมตาสำหรับสตริงที่จะอัปโหลด |
ผลตอบแทน:
สัญญา < อัพโหลดผลลัพธ์ >
คำสัญญาที่มี UploadResult
ฟังก์ชั่น (storageOrRef, ...)
อ้างอิง (storageOrRef, เส้นทาง)
ส่งคืน StorageReference สำหรับเส้นทางที่กำหนดในที่เก็บข้อมูลเริ่มต้น
ลายเซ็น:
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ที่เก็บข้อมูลหรืออ้างอิง | FirebaseStorage | การอ้างอิงการจัดเก็บข้อมูล | FirebaseStorage หรือ StorageReference . |
เส้นทาง | เชือก |
ผลตอบแทน:
รูปแบบสตริง
การแจงนับรูปแบบสตริงที่เป็นไปได้สำหรับการอัปโหลด
ลายเซ็น:
StringFormat: {
readonly RAW: "raw";
readonly BASE64: "base64";
readonly BASE64URL: "base64url";
readonly DATA_URL: "data_url";
}
รูปแบบสตริง
การแจงนับรูปแบบสตริงที่เป็นไปได้สำหรับการอัปโหลด
ลายเซ็น:
export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
งานกิจกรรม
เหตุการณ์ที่ถูกทริกเกอร์ในงาน
ลายเซ็น:
export declare type TaskEvent = 'state_changed';
สถานะงาน
แสดงถึงสถานะปัจจุบันของการอัปโหลดที่ทำงานอยู่
ลายเซ็น:
export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
รหัสข้อผิดพลาดในการจัดเก็บ
รหัสข้อผิดพลาดที่สามารถแนบไปกับวัตถุ StorageError
ลายเซ็น:
export declare enum StorageErrorCode
สมาชิกแจงนับ
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
APP_DELETED | "app-deleted" | |
BUCKET_NOT_FOUND | "bucket-not-found" | |
ยกเลิก | "canceled" | |
ไม่สามารถ_SLICE_BLOB | "cannot-slice-blob" | |
ภายใน_ข้อผิดพลาด | "internal-error" | |
INVALID_ARGUMENT | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
รูปแบบไม่ถูกต้อง | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
URL ไม่ถูกต้อง | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
NO_ดาวน์โหลด_URL | "no-download-url" | |
OBJECT_NOT_FOUND | "object-not-found" | |
โครงการ_NOT_FOUND | "project-not-found" | |
QUOTA_EXCEEDED | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVER_FILE_WRONG_SIZE | "server-file-wrong-size" | |
ไม่ได้รับอนุญาต | "unauthenticated" | |
ไม่ได้รับอนุญาต | "unauthorized" | |
ไม่ได้รับอนุญาต_APP | "unauthorized-app" | |
ไม่ทราบ | "unknown" | |
ไม่สนับสนุน_สิ่งแวดล้อม | "unsupported-environment" |