storage package

Cloud Storage cho Firebase

Hàm

Lớp học

Liệt kê

Giao diện

Biến

Nhập bí danh

function(app, ...)

getStorage(ứng dụng, BucketUrl)

Lấy một phiên bản FirebaseStorage cho ứng dụng Firebase cụ thể.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

FirebaseStorage

Một phiên bản FirebaseStorage.

function(lưu trữ, ...)

connectionStorageEmulator(bộ nhớ, máy chủ lưu trữ, cổng, các tuỳ chọn)

Sửa đổi thực thể 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ường hợp trả lại hàng:

trống

ref(storage; url)

Trả về StorageReference cho url đã cho.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

StorageReference

function(ref, ...)

deleteObject(ref)

Xoá đối tượng tại vị trí này.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise sẽ được phân giải nếu xoá thành công.

getBlob(ref; maxDownloadSizeBytes)

Tải dữ liệu xuống 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 của ứng dụng vào danh sách cho phép trong bộ chứa Cloud Storage. Xem thêm tại https://cloud.google.com/storage/docs/configure-cors

API này không có trong Nút.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Cam kết<Blob>

Lời hứa phân giải bằng Blob chứa các byte của đối tượng

getBytes(ref; maxDownloadSizeBytes)

Tải dữ liệu xuống 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 của ứng dụng vào danh sách cho phép trong bộ chứa Cloud Storage. Xem thêm tại https://cloud.google.com/storage/docs/configure-cors

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Cam kết<ArrayBuffer>

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

getDownloadURL(ref)

Trả về URL tải xuống cho StorageReference cho sẵn.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Cam kết<string>

Promise phân giải bằng URL tải xuống cho đối tượng này.

getMetadata(ref)

Promise phân giải 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 truy xuất được 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ường hợp trả lại hàng:

Cam kết<FullMetadata>

getStream(ref; maxDownloadSizeBytes)

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

API này chỉ có trong Nút.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Luồng có thể đọc

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

list(ref; tuỳ chọn)

Liệt kê các mục (tệp) và tiền tố (thư mục) trong nội dung tham khảo về bộ nhớ này.

List API chỉ dùng được cho Quy tắc Firebase phiên bản 2.

GCS là một kho lưu trữ khoá-blob. Bộ nhớ Firebase áp dụng ngữ nghĩa của '/' cấu trúc thư mục được phân tách. Hãy tham khảo List API 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ộ nhớ Firebase không hỗ trợ những đối tượng có đường dẫn kết thúc bằng "/" hoặc chứa hai "/" liên tiếp. Firebase Storage List API sẽ lọc những đối tượng không được hỗ trợ này. list() có thể không thành công 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ường hợp trả lại hàng:

Hứa hẹn<ListResult>

Promise phân giải với các mặt hàng và tiền tố. prefixes chứa thông tin tham chiếu đến các thư mục con và items chứa thông tin tham chiếu đến các đối tượng trong thư mục này. Bạn có thể sử dụng nextPageToken để nhận các kết quả còn lại.

listAll(ref)

Liệt kê tất cả các mục (tệp) và tiền tố (thư mục) trong phần tham khảo về bộ nhớ 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ường hợp trả lại hàng:

Hứa hẹn<ListResult>

Promise phân giải với tất cả các mục và tiền tố trong tham chiếu bộ nhớ hiện tại. prefixes chứa thông tin tham chiếu đến các thư mục con và items chứa thông tin tham chiếu đến các đối tượng trong thư mục này. nextPageToken sẽ không bao giờ được trả về.

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ường hợp trả lại hàng:

Cam kết<FullMetadata>

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

upBytes(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 không thể tiếp tục.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Hứa hẹn<UploadResult>

Lời hứa có chứa một UploadResult

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ị thông tin cập nhật về tiến trình.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

UploadTask (Tác vụ tải lên)

một UploadTask

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. Quá trình tải lên không thể tiếp tục.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Hứa hẹn<UploadResult>

Lời hứa có chứa một UploadResult

function(storageOrRef, ...)

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

Trả về StorageReference cho đường dẫn đã cho trong bộ chứa mặc định.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

StorageReference

Đị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 tác 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 tác vụ

Biểu thị trạng thái hiện tại của tệp tải lên đang chạy.

Chữ ký:

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

Mã lỗi bộ nhớ

Mã lỗi có thể đính kèm vào đối tượng StorageError.

Chữ ký:

export declare enum StorageErrorCode 

Thành viên liệt kê