storage package

Bộ nhớ đám mây cho Firebase

Chức năng

Các lớp học

Bảng liệt kê

Giao diện

Biến

Nhập bí danh

chức năng (ứng dụng, ...)

getStorage(ứng dụng, xôUrl)

Nhận phiên bản FirebaseStorage cho ứng dụng Firebase nhất định.

Chữ ký:

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

Thông số

Trả về:

Bộ nhớ Firebase

Một phiên bản FirebaseStorage .

chức năng (lưu trữ, ...)

connectStorageEmulator(lưu trữ, máy chủ, cổng, tùy chọn)

Sửa đổi phiên bản FirebaseStorage này để giao tiếp với trình mô phỏng Cloud Storage.

Chữ ký:

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

Thông số

Trả về:

trống rỗng

ref(lưu ​​trữ, url)

Trả về StorageReference cho url đã cho.

Chữ ký:

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

Thông số

Trả về:

Lưu trữTham khảo

hàm(ref, ...)

xóaObject(ref)

Xóa đối tượng tại vị trí này.

Chữ ký:

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

Thông số

Trả về:

Hứa<void>

Một Promise sẽ được giải quyết nếu việc xóa thành công.

getBlob(ref, maxDownloadSizeBytes)

Tải xuống dữ liệu tại vị trí của đối tượng. Trả về lỗi nếu không tìm thấy đối tượng.

Để sử dụng chức năng này, bạn phải đưa nguồn gốc ứng dụng của mình vào danh sách trắng trong nhóm Lưu trữ đám mây. Xem thêm https://cloud.google.com/storage/docs/configuring-cors

API này không có sẵn trong Node.

Chữ ký:

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

Thông số

Trả về:

Hứa<Blob>

Lời hứa được giải quyết bằng Blob chứa byte của đối tượng

getBytes(ref, maxDownloadSizeBytes)

Tải xuống dữ liệu tại vị trí của đối tượng. Trả về lỗi nếu không tìm thấy đối tượng.

Để sử dụng chức năng này, bạn phải đưa nguồn gốc ứng dụng của mình vào danh sách trắng trong nhóm Lưu trữ đám mây. Xem thêm https://cloud.google.com/storage/docs/configuring-cors

Chữ ký:

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

Thông số

Trả về:

Lời hứa<ArrayBuffer>

Lời hứa chứa byte của đối tượng

getDownloadURL(ref)

Trả về URL tải xuống cho StorageReference đã cho .

Chữ ký:

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

Thông số

Trả về:

Hứa<string>

Promise được giải quyết bằng URL tải xuống cho đối tượng này.

getMetadata(ref)

Promise giải quyết bằng siêu dữ liệu cho đối tượng này. Nếu đối tượng này không tồn tại hoặc không thể truy xuất siêu dữ liệu thì lời hứa sẽ bị từ chối.

Chữ ký:

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

Thông số

Trả về:

Hứa < Siêu dữ liệu đầy đủ >

getStream(ref, maxDownloadSizeBytes)

Tải xuống dữ liệu tại vị trí của đối tượng. Phát sinh sự kiện lỗi nếu không tìm thấy đối tượng.

API này chỉ khả dụng trong Node.

Chữ ký:

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

Thông số

Trả về:

NodeJS.ReadableStream

Một luồng có dữ liệu của đối tượng dưới dạng byte

danh sách (ref, tùy chọn)

Liệt kê các mục (tệp) và tiền tố (thư mục) trong tham chiếu lưu trữ này.

API danh sách chỉ khả dụng cho Quy tắc Firebase phiên bản 2.

GCS là một cửa hàng key-blob. Bộ lưu trữ Firebase áp đặt ngữ nghĩa của cấu trúc thư mục được phân tách bằng '/'. Hãy tham khảo API danh sách của GCS nếu bạn muốn tìm hiểu thêm.

Để tuân thủ Ngữ nghĩa của Quy tắc Firebase, Bộ lưu trữ Firebase không hỗ trợ các đối tượng có đường dẫn kết thúc bằng "/" hoặc chứa hai "/" liên tiếp. API danh sách lưu trữ Firebase sẽ lọc các đối tượng không được hỗ trợ này. list() có thể thất bại nếu có quá nhiều đối tượng không được hỗ trợ trong nhóm.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Danh sáchKết quả >

Một Promise được giải quyết bằng các mục và tiền tố. prefixes chứa tham chiếu đến các thư mục con và items tham chiếu đến các đối tượng trong thư mục này. nextPageToken có thể được sử dụng để nhận phần còn lại của kết quả.

danh sáchTất cả(ref)

Liệt kê tất cả các mục (tệp) và tiền tố (thư mục) trong tham chiếu lưu trữ này.

Đây là một phương thức trợ giúp để gọi list() nhiều lần cho đến khi không còn kết quả nào nữa. Kích thước phân trang mặc định là 1000.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Danh sáchKết quả >

Promise giải quyết tất cả các mục và tiền tố trong tham chiếu lưu trữ hiện tại. prefixes chứa tham chiếu đến thư mục con và items chứa tham chiếu đến đối tượng trong thư mục này. nextPageToken không bao giờ được trả lại.

updateMetadata(ref, siêu dữ liệu)

Cập nhật siêu dữ liệu cho đối tượng này.

Chữ ký:

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

Thông số

Trả về:

Hứa < Siêu dữ liệu đầy đủ >

Promise được giải quyết bằng siêu dữ liệu mới cho đối tượng này.

uploadBytes(ref, dữ liệu, siêu dữ liệu)

Tải dữ liệu lên vị trí của đối tượng này. Việc tải lên không thể tiếp tục được.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Tải lênKết quả >

Lời hứa chứa Kết quả tải lên

uploadBytesResumable(ref, dữ liệu, siêu dữ liệu)

Tải dữ liệu lên vị trí của đối tượng này. Quá trình tải lên có thể bị tạm dừng và tiếp tục, đồng thời hiển thị các cập nhật tiến trình.

Chữ ký:

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

Thông số

Trả về:

Nhiệm vụ tải lên

Nhiệm vụ tải lên

uploadString(ref, giá trị, định dạng, siêu dữ liệu)

Tải một chuỗi lên vị trí của đối tượng này. Việc tải lên không thể tiếp tục được.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Tải lênKết quả >

Lời hứa chứa Kết quả tải lên

hàm(storageOrRef, ...)

ref(storageOrRef, đường dẫn)

Trả về StorageReference cho đường dẫn đã cho trong nhóm mặc định.

Chữ ký:

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

Thông số

Trả về:

Lưu trữTham khảo

Định dạng chuỗi

Bảng liệt kê các định dạng chuỗi có thể tải lên.

Chữ ký:

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

Định dạng chuỗi

Bảng liệt kê các định dạng chuỗi có thể tải lên.

Chữ ký:

export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

Sự kiện nhiệm vụ

Một sự kiện được kích hoạt trong một nhiệm vụ.

Chữ ký:

export declare type TaskEvent = 'state_changed';

Trạng thái nhiệm vụ

Thể hiện trạng thái hiện tại của quá trình tải lên đang chạy.

Chữ ký:

export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

Lưu trữMã lỗi

Mã lỗi có thể được gắn vào đối tượng StorageError .

Chữ ký:

export declare enum StorageErrorCode 

Thành viên điều tra