storage package

Cloud Storage for Firebase

Functions

Fungsi Deskripsi
fungsi(aplikasi, ...)
getStorage(aplikasi, bucketUrl) Mendapatkan instance FirebaseStorage untuk aplikasi Firebase tertentu.
fungsi(penyimpanan, ...)
connectStorageEmulator(penyimpanan, host, port, opsi) Ubah instance FirebaseStorage ini untuk berkomunikasi dengan emulator Cloud Storage.
ref(penyimpanan, url) Menampilkan StorageReference untuk URL yang diberikan.
fungsi(ref, ...)
deleteObject(ref) Menghapus objek di lokasi ini.
getBlob(ref, maxDownloadSizeBytes) Mendownload data di lokasi objek. Menampilkan error jika objek tidak ditemukan.Untuk menggunakan fungsi ini, Anda harus mengizinkan asal aplikasi di bucket Cloud Storage. Lihat juga https://cloud.google.com/storage/docs/configure-corsAPI ini tidak tersedia di Node.
getBytes(ref, maxDownloadSizeBytes) Mendownload data di lokasi objek. Menampilkan error jika objek tidak ditemukan.Untuk menggunakan fungsi ini, Anda harus mengizinkan asal aplikasi di bucket Cloud Storage. Lihat juga https://cloud.google.com/storage/docs/configure-cors
getDownloadURL(ref) Menampilkan URL download untuk StorageReference yang diberikan.
getMetadata(ref) Promise yang di-resolve dengan metadata untuk objek ini. Jika objek ini tidak ada atau metadata tidak dapat diambil, promise akan ditolak.
getStream(ref, maxDownloadSizeBytes) Mendownload data di lokasi objek. Meningkatkan peristiwa error jika objek tidak ditemukan.API ini hanya tersedia di Node.
list(ref, opsi) Daftar item (file) dan awalan (folder) dalam referensi penyimpanan ini.List API hanya tersedia untuk Aturan Firebase Versi 2.GCS adalah penyimpanan key-blob. Firebase Storage menerapkan semantik '/' dan {i>delimited folder structure<i}. Lihat List API GCS jika Anda ingin mempelajari lebih lanjut.Untuk mematuhi Semantik Aturan Firebase, Firebase Storage tidak mendukung objek yang jalurnya diakhiri dengan "/" atau berisi dua tanda "/" berturut-turut. Firebase Storage List API akan memfilter objek yang tidak didukung ini. list() mungkin gagal jika ada terlalu banyak objek yang tidak didukung dalam bucket.
listAll(ref) Buat daftar semua item (file) dan awalan (folder) pada referensi penyimpanan ini.Ini adalah metode bantuan untuk memanggil list() berulang kali hingga tidak ada hasil lagi. Ukuran penomoran halaman default adalah 1000.Catatan: Hasilnya mungkin tidak konsisten jika objek diubah saat operasi ini berjalan.Peringatan: listAll berpotensi menggunakan terlalu banyak resource jika terlalu banyak hasil.
updateMetadata(ref, metadata) Memperbarui metadata untuk objek ini.
uploadBytes(ref, data, metadata) Mengupload data ke lokasi objek ini. Upload tidak dapat dilanjutkan.
uploadBytesResumable(ref, data, metadata) Mengupload data ke lokasi objek ini. Upload dapat dijeda dan dilanjutkan, serta menampilkan pembaruan progres.
uploadString(ref, nilai, format, metadata) Mengupload string ke lokasi objek ini. Upload tidak dapat dilanjutkan.
function(storageOrRef, ...)
ref(storageOrRef, path) Menampilkan StorageReference untuk jalur yang diberikan di bucket default.

Kelas

Class Deskripsi
Error Storage Error yang ditampilkan oleh Firebase Storage SDK.

Enumeration

Enumerasi Deskripsi
StorageErrorCode Kode error yang dapat dilampirkan ke objek StorageError.

Antarmuka

Antarmuka Deskripsi
FirebaseStorage Instance Firebase Storage.
FullMetadata Kumpulan lengkap metadata objek, termasuk properti hanya baca.
ListOptions Opsi list() diterima.
ListResult Hasil yang ditampilkan oleh list().
SettableMetadata Metadata objek yang dapat ditetapkan kapan saja.
StorageObserver Stream observer untuk Firebase Storage.
StorageReference Merepresentasikan referensi ke objek Google Cloud Storage. Developer dapat mengupload, mendownload, dan menghapus objek, serta metadata objek get/set.
MetadataUpload Metadata objek yang dapat ditetapkan saat upload.
UploadResult Hasil yang ditampilkan dari upload yang tidak dapat dilanjutkan.
UploadTask Merepresentasikan proses upload objek. Memungkinkan Anda memantau dan mengelola upload.
UploadTaskSnapshot Menyimpan data tentang status tugas upload saat ini.

Variabel

Variabel Deskripsi
StringFormat Enumerasi kemungkinan format string untuk upload.

Ketik Alias

Ketik Alias Deskripsi
StringFormat Enumerasi kemungkinan format string untuk upload.
TaskEvent Peristiwa yang dipicu pada tugas.
TaskState Menunjukkan status saat ini dari upload yang sedang berjalan.

function(aplikasi, ...)

getStorage(aplikasi, bucketUrl)

Mendapatkan instance FirebaseStorage untuk aplikasi Firebase tertentu.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
aplikasi AplikasiFirebase Aplikasi Firebase untuk mendapatkan instance FirebaseStorage.
URL bucket string URL gs:// ke Bucket Firebase Storage Anda. Jika tidak diteruskan, Bucket Penyimpanan default aplikasi akan digunakan.

Hasil:

FirebaseStorage

Instance FirebaseStorage.

function(penyimpanan, ...)

connectStorageEmulator(penyimpanan, host, port, opsi)

Ubah instance FirebaseStorage ini untuk berkomunikasi dengan emulator Cloud Storage.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
storage FirebaseStorage Instance FirebaseStorage
host string Host emulator (misalnya: localhost)
port angka Port emulator (mis.: 5001)
opsi { mockUserToken?: EmulatorMockTokenOptions | {i>string<i}; } Opsi emulator. options.mockUserToken adalah token autentikasi tiruan yang digunakan untuk pengujian unit Aturan Keamanan.

Hasil:

void

ref(penyimpanan, url)

Menampilkan StorageReference untuk URL yang diberikan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
storage FirebaseStorage FirebaseStorage.
url string . Jika kosong, menampilkan referensi root.

Hasil:

StorageReference

function(ref, ...)

deleteObject(ref)

Menghapus objek di lokasi ini.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference untuk objek yang akan dihapus.

Hasil:

Janji<void>

Promise yang di-resolve jika penghapusan berhasil.

getBlob(ref, maxDownloadSizeBytes)

Mendownload data di lokasi objek. Menampilkan error jika objek tidak ditemukan.

Untuk menggunakan fungsi ini, Anda harus mengizinkan asal aplikasi di bucket Cloud Storage. Lihat juga https://cloud.google.com/storage/docs/configure-cors

API ini tidak tersedia di Node.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference tempat data akan didownload.
maxDownloadSizeBytes angka Jika disetel, ukuran maksimum yang diizinkan dalam byte yang akan diambil.

Hasil:

Promise<Blob>

Promise yang di-resolve dengan Blob yang berisi byte objek

getBytes(ref, maxDownloadSizeBytes)

Mendownload data di lokasi objek. Menampilkan error jika objek tidak ditemukan.

Untuk menggunakan fungsi ini, Anda harus mengizinkan asal aplikasi di bucket Cloud Storage. Lihat juga https://cloud.google.com/storage/docs/configure-cors

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference tempat data akan didownload.
maxDownloadSizeBytes angka Jika disetel, ukuran maksimum yang diizinkan dalam byte yang akan diambil.

Hasil:

Promise<ArrayBuffer>

Promise yang berisi byte objek

getDownloadURL(referensi)

Menampilkan URL download untuk StorageReference yang diberikan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference untuk mendapatkan URL download.

Hasil:

Promise<string>

Promise yang di-resolve dengan URL download untuk objek ini.

getMetadata(ref)

Promise yang di-resolve dengan metadata untuk objek ini. Jika objek ini tidak ada atau metadata tidak dapat diambil, promise akan ditolak.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference untuk mendapatkan metadata.

Hasil:

Promise<FullMetadata>

getStream(ref, maxDownloadSizeBytes)

Mendownload data di lokasi objek. Meningkatkan peristiwa error jika objek tidak ditemukan.

API ini hanya tersedia di Node.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference tempat data akan didownload.
maxDownloadSizeBytes angka Jika disetel, ukuran maksimum yang diizinkan dalam byte yang akan diambil.

Hasil:

Dapat Dibaca

Aliran data dengan data objek sebagai byte

list(ref, opsi)

Cantumkan item (file) dan awalan (folder) berdasarkan referensi penyimpanan ini.

List API hanya tersedia untuk Aturan Firebase Versi 2.

GCS adalah penyimpanan key-blob. Firebase Storage menerapkan semantik '/' dan {i>delimited folder structure<i}. Lihat List API GCS jika Anda ingin mempelajari lebih lanjut.

Untuk mematuhi Semantik Aturan Firebase, Firebase Storage tidak mendukung objek yang jalurnya diakhiri dengan "/" atau berisi dua tanda "/" berturut-turut. Firebase Storage List API akan memfilter objek yang tidak didukung ini. list() mungkin gagal jika ada terlalu banyak objek yang tidak didukung dalam bucket.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference untuk mendapatkan daftar.
opsi ListOptions Lihat ListOptions untuk mengetahui detailnya.

Hasil:

Promise<ListResult>

Promise yang di-resolve dengan item dan awalan. prefixes berisi referensi ke subfolder dan items berisi referensi ke objek dalam folder ini. nextPageToken dapat digunakan untuk mendapatkan hasil lainnya.

listAll(ref)

Cantumkan semua item (file) dan awalan (folder) berdasarkan referensi penyimpanan ini.

Ini adalah metode bantuan untuk memanggil list() berulang kali hingga tidak ada hasil lagi. Ukuran penomoran halaman default adalah 1000.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference untuk mendapatkan daftar.

Hasil:

Promise<ListResult>

Promise yang di-resolve dengan semua item dan awalan berdasarkan referensi penyimpanan saat ini. prefixes berisi referensi ke subdirektori dan items berisi referensi ke objek dalam folder ini. nextPageToken tidak pernah ditampilkan.

updateMetadata(ref, metadata)

Memperbarui metadata untuk objek ini.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference untuk memperbarui metadata.
metadata SettableMetadata Metadata baru untuk objek. Hanya nilai yang telah ditetapkan secara eksplisit yang akan diubah. Menetapkan nilai secara eksplisit ke null akan menghapus metadata.

Hasil:

Promise<FullMetadata>

Promise yang di-resolve dengan metadata baru untuk objek ini.

uploadBytes(ref, data, metadata)

Mengupload data ke lokasi objek ini. Upload tidak dapat dilanjutkan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference tempat data akan diupload.
data Gumpalan | Uint8Array | ArrayBuffer Data yang akan diupload.
metadata MetadataUpload Metadata untuk data yang akan diupload.

Hasil:

Promise<UploadResult>

Promise yang berisi UploadResult

uploadBytesResumable(ref, data, metadata)

Mengupload data ke lokasi objek ini. Upload dapat dijeda dan dilanjutkan, serta menampilkan pembaruan progres.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference tempat data akan diupload.
data Gumpalan | Uint8Array | ArrayBuffer Data yang akan diupload.
metadata MetadataUpload Metadata untuk data yang akan diupload.

Hasil:

UploadTask

UploadTask

uploadString(ref, nilai, format, metadata)

Mengupload string ke lokasi objek ini. Upload tidak dapat dilanjutkan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
referensi StorageReference StorageReference tempat string harus diupload.
value string String yang akan diupload.
format StringFormat Format string yang akan diupload.
metadata MetadataUpload Metadata untuk string yang akan diupload.

Hasil:

Promise<UploadResult>

Promise yang berisi UploadResult

function(storageOrRef, ...)

ref(storageOrRef, jalur)

Menampilkan StorageReference untuk jalur yang diberikan di bucket default.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
storageOrRef FirebaseStorage | StorageReference FirebaseStorage atau StorageReference.
jalur string

Hasil:

StorageReference

FormatString

Enumerasi kemungkinan format string untuk upload.

Tanda Tangan:

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

FormatString

Enumerasi kemungkinan format string untuk upload.

Tanda Tangan:

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

{i>TaskEvent<i}

Peristiwa yang dipicu pada tugas.

Tanda Tangan:

export declare type TaskEvent = 'state_changed';

{i>TaskState<i}

Menunjukkan status saat ini dari upload yang sedang berjalan.

Tanda Tangan:

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

StorageErrorCode

Kode error yang dapat dilampirkan ke objek StorageError.

Tanda Tangan:

export declare enum StorageErrorCode

Anggota Enumerasi

Anggota Nilai Deskripsi
APP_DIHAPUS "app-deleted"
BUCKET_TIDAK_DITEMUKAN "bucket-not-found"
DIBATALKAN "canceled"
CANNOT_SLICE_BLOB "cannot-slice-blob"
INTERNAL_ERROR "internal-error"
INVALID_ARGUMENT "invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
INVALID_CHECKSUM "invalid-checksum"
BUCKET_DEFAULT_INVALID "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
FORMAT_TIDAK VALID "invalid-format"
OPERASI_ROOT_TIDAK_VALID "invalid-root-operation"
URL_TIDAK VALID "invalid-url"
TANPA_DEFAULT_BUCKET "no-default-bucket"
TIDAK ADA DOWNLOAD_URL "no-download-url"
OBJECT_NOT_FOUND "object-not-found"
PROJECT_TIDAK_DITEMUKAN "project-not-found"
QUOTA_EXCEEDED "quota-exceeded"
RETRY_LIMIT_EXCEEDED menjadi "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
UNAUTHENTICATED "unauthenticated"
TIDAK SAH "unauthorized"
APLIKASI_UNAUTHORIZED "unauthorized-app"
TIDAK DIKETAHUI "unknown"
LINGKUNGAN_UNSUPPORTED "unsupported-environment"