storage package

Cloud Storage for Firebase

ฟังก์ชัน

ชั้นเรียน

การแจงนับ

อินเทอร์เฟซ

ตัวแปร

พิมพ์ชื่อแทน

ฟังก์ชัน(แอป, ...)

getStorage(แอป, BucketUrl)

รับอินสแตนซ์ FirebaseStorage สำหรับแอป Firebase ที่ระบุ

ลายเซ็น:

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

พารามิเตอร์

การคืนสินค้า:

FirebaseStorage

อินสแตนซ์ FirebaseStorage

ฟังก์ชัน(พื้นที่เก็บข้อมูล, ...)

ConnectStorageEmulator(พื้นที่เก็บข้อมูล โฮสต์ พอร์ต ตัวเลือก)

แก้ไขอินสแตนซ์ FirebaseStorage นี้เพื่อสื่อสารกับโปรแกรมจำลอง Cloud Storage

ลายเซ็น:

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

พารามิเตอร์

การคืนสินค้า:

เป็นโมฆะ

ref(พื้นที่เก็บข้อมูล, url)

แสดงผล StorageReference สำหรับ URL ที่ระบุ

ลายเซ็น:

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

พารามิเตอร์

การคืนสินค้า:

StorageReference

ฟังก์ชัน(อ้างอิง, ...)

DeleteObject(อ้างอิง)

ลบออบเจ็กต์ในตำแหน่งนี้

ลายเซ็น:

export declare function deleteObject(ref: StorageReference): Promise<void>;

พารามิเตอร์

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ที่จะแก้ไขหากลบสำเร็จ

getBlob(ref, maxDownloadSizeBytes)

ดาวน์โหลดข้อมูลที่ตำแหน่งของออบเจ็กต์ แสดงผลข้อผิดพลาดหากไม่พบออบเจ็กต์

หากต้องการใช้ฟังก์ชันนี้ คุณต้องเพิ่มต้นทางของแอปในรายการที่อนุญาตพิเศษในที่เก็บข้อมูล Cloud Storage ดู https://cloud.google.com/storage/docs/configuring-cors

API นี้ไม่พร้อมใช้งานในโหนด

ลายเซ็น:

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

พารามิเตอร์

การคืนสินค้า:

สัญญานะ<Blob>

Promise ที่แก้ปัญหาด้วย Blob ที่มีไบต์ของออบเจ็กต์

getBytes(ref, maxDownloadSizeBytes)

ดาวน์โหลดข้อมูลที่ตำแหน่งของออบเจ็กต์ แสดงผลข้อผิดพลาดหากไม่พบออบเจ็กต์

หากต้องการใช้ฟังก์ชันนี้ คุณต้องเพิ่มต้นทางของแอปในรายการที่อนุญาตพิเศษในที่เก็บข้อมูล Cloud Storage ดู https://cloud.google.com/storage/docs/configuring-cors

ลายเซ็น:

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

พารามิเตอร์

การคืนสินค้า:

สัญญา <ArrayBuffer>

คำสัญญาที่มีไบต์ของออบเจ็กต์

getDownloadURL(อ้างอิง)

แสดง URL การดาวน์โหลดสำหรับ StorageReference ที่ระบุ

ลายเซ็น:

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

พารามิเตอร์

การคืนสินค้า:

คำมั่นสัญญา<สตริง>

Promise ที่แปลงด้วย URL การดาวน์โหลดสำหรับออบเจ็กต์นี้

getMetadata(อ้างอิง)

Promise ที่แก้ไขด้วยข้อมูลเมตาสำหรับออบเจ็กต์นี้ หากไม่มีออบเจ็กต์นี้อยู่หรือเรียกดูข้อมูลเมตาไม่ได้ ระบบจะปฏิเสธสัญญา

ลายเซ็น:

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<FullMetadata>

getStream(ref, maxDownloadSizeBytes)

ดาวน์โหลดข้อมูลที่ตำแหน่งของออบเจ็กต์ เพิ่มเหตุการณ์ข้อผิดพลาดหากไม่พบออบเจ็กต์

API นี้มีให้บริการในโหนดเท่านั้น

ลายเซ็น:

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;

พารามิเตอร์

การคืนสินค้า:

สตรีมที่อ่านได้

สตรีมที่มีข้อมูลของออบเจ็กต์เป็นไบต์

รายการ(อ้างอิง, ตัวเลือก)

แสดงรายการ (ไฟล์) และคำนำหน้า (โฟลเดอร์) ภายใต้การอ้างอิงพื้นที่เก็บข้อมูลนี้

List API ใช้ได้เฉพาะกับกฎ Firebase เวอร์ชัน 2

GCS เป็น Key-BLOB Store พื้นที่เก็บข้อมูลของ Firebase กำหนดความหมายของ "/" โครงสร้างโฟลเดอร์ที่คั่นด้วยการ โปรดดูข้อมูลเพิ่มเติมที่ List API ของ GCS

พื้นที่เก็บข้อมูลของ Firebase จะไม่รองรับออบเจ็กต์ที่เส้นทางลงท้ายด้วย "/" เพื่อให้เป็นไปตามความหมายของกฎ Firebase หรือมี "/" 2 ตัวติดกัน Firebase Storage List API จะกรองออบเจ็กต์ที่ไม่รองรับเหล่านี้ list() อาจล้มเหลวหากมีออบเจ็กต์ที่ไม่รองรับมากเกินไปในที่เก็บข้อมูล

ลายเซ็น:

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<ListResult>

Promise ที่แปลงค่าด้วยรายการและคำนำหน้า prefixes มีการอ้างอิงถึงโฟลเดอร์ย่อย และ items มีการอ้างอิงถึงออบเจ็กต์ในโฟลเดอร์นี้ คุณสามารถใช้ nextPageToken เพื่อรับผลลัพธ์ที่เหลือ

รายการทั้งหมด(อ้างอิง)

แสดงรายการ (ไฟล์) และคำนำหน้า (โฟลเดอร์) ทั้งหมดภายใต้การอ้างอิงพื้นที่เก็บข้อมูลนี้

นี่เป็นเมธอดช่วยสำหรับการเรียกใช้ list() ซ้ำๆ จนกว่าจะไม่มีผลลัพธ์เพิ่มเติม ขนาดการแบ่งหน้าเริ่มต้นคือ 1000

ลายเซ็น:

export declare function listAll(ref: StorageReference): Promise<ListResult>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<ListResult>

Promise ที่แก้ไขปัญหาด้วยรายการและคำนำหน้าทั้งหมดภายใต้การอ้างอิงพื้นที่เก็บข้อมูลปัจจุบัน prefixes มีการอ้างอิงถึงไดเรกทอรีย่อย และ items มีการอ้างอิงถึงออบเจ็กต์ในโฟลเดอร์นี้ และจะไม่มีการส่งคืน nextPageToken

อัปเดตข้อมูลเมตา(อ้างอิง ข้อมูลเมตา)

อัปเดตข้อมูลเมตาสำหรับออบเจ็กต์นี้

ลายเซ็น:

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<FullMetadata>

Promise ที่แก้ไขด้วยข้อมูลเมตาใหม่สำหรับออบเจ็กต์นี้

uploadBytes(อ้างอิง, ข้อมูล, ข้อมูลเมตา)

อัปโหลดข้อมูลไปยังตำแหน่งของออบเจ็กต์นี้ การอัปโหลดไม่สามารถดำเนินการต่อได้

ลายเซ็น:

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<ผลลัพธ์การอัปโหลด>

คำสัญญาที่มีผลลัพธ์การอัปโหลด

uploadBytesResumable(อ้างอิง, ข้อมูล, ข้อมูลเมตา)

อัปโหลดข้อมูลไปยังตำแหน่งของออบเจ็กต์นี้ การอัปโหลดสามารถหยุดชั่วคราวและทำต่อได้ โดยจะแสดงการอัปเดตความคืบหน้า

ลายเซ็น:

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

พารามิเตอร์

การคืนสินค้า:

UploadTask

งานการอัปโหลด

uploadString(การอ้างอิง, ค่า, รูปแบบ, ข้อมูลเมตา)

อัปโหลดสตริงไปยังตำแหน่งของออบเจ็กต์นี้ การอัปโหลดไม่สามารถดำเนินการต่อได้

ลายเซ็น:

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<ผลลัพธ์การอัปโหลด>

คำสัญญาที่มีผลลัพธ์การอัปโหลด

function(storageOrRef, ...)

ref(storageOrRef, เส้นทาง)

แสดงผล StorageReference สำหรับเส้นทางที่ระบุในที่เก็บข้อมูลเริ่มต้น

ลายเซ็น:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

พารามิเตอร์

การคืนสินค้า:

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

StorageErrorCode

รหัสข้อผิดพลาดที่สามารถแนบกับออบเจ็กต์ StorageError รายการ

ลายเซ็น:

export declare enum StorageErrorCode 

สมาชิกการแจงนับ