storage package

Firebase için Bulut Depolama

Fonksiyonlar

İşlev Tanım
işlev(uygulama, ...)
getStorage(app, BucketUrl) Belirtilen Firebase uygulaması için bir FirebaseStorage örneği alır.
fonksiyon(depolama, ...)
connectStorageEmulator(depolama, ana bilgisayar, bağlantı noktası, seçenekler) Cloud Storage emülatörüyle iletişim kurmak için bu FirebaseStorage örneğini değiştirin.
ref(depolama, url) Verilen URL için bir StorageReference döndürür.
fonksiyon(ref, ...)
deleteObject(ref) Bu konumdaki nesneyi siler.
getBlob(ref, maxDownloadSizeBytes) Verileri nesnenin konumuna indirir. Nesne bulunamazsa hata döndürür. Bu işlevi kullanmak için uygulamanızın kaynağını Cloud Storage paketinizde beyaz listeye eklemeniz gerekir. Ayrıca bkz. https://cloud.google.com/storage/docs/configuring-cors Bu API Node.js'de mevcut değil.
getBytes(ref, maxDownloadSizeBytes) Verileri nesnenin konumuna indirir. Nesne bulunamazsa hata döndürür. Bu işlevi kullanmak için uygulamanızın kaynağını Cloud Storage paketinizde beyaz listeye eklemeniz gerekir. Ayrıca bkz. https://cloud.google.com/storage/docs/configuring-cors
getDownloadURL(ref) Verilen StorageReference için indirme URL'sini döndürür .
getMetadata(ref) Bu nesnenin meta verileriyle çözümlenen bir Promise . Bu nesne mevcut değilse veya meta veriler alınamıyorsa söz reddedilir.
getStream(ref, maxDownloadSizeBytes) Verileri nesnenin konumuna indirir. Nesne bulunamazsa bir hata olayı başlatır. Bu API yalnızca Node.js'de mevcuttur.
liste(ref, seçenekler) Bu depolama referansı altındaki öğeleri (dosyaları) ve önekleri (klasörleri) listeleyin. Liste API'si yalnızca Firebase Kuralları Sürüm 2 için kullanılabilir. GCS bir anahtar bloğu deposudur. Firebase Storage, '/' sınırlandırılmış klasör yapısının anlamını uygular. Daha fazla bilgi edinmek istiyorsanız GCS'nin Liste API'sine bakın. Firebase Kurallarının Semantiğine uymak için Firebase Storage, yolları "/" ile biten veya ardışık iki "/" içeren nesneleri desteklemez. Firebase Depolama Listesi API'si bu desteklenmeyen nesneleri filtreleyecektir. Pakette çok fazla desteklenmeyen nesne varsa list() başarısız olabilir.
listeTümü(ref) Bu depolama referansı altındaki tüm öğeleri (dosyaları) ve önekleri (klasörleri) listeleyin. Bu, daha fazla sonuç kalmayıncaya kadar list() işlevini tekrar tekrar çağırmak için kullanılan yardımcı bir yöntemdir. Varsayılan sayfalandırma boyutu 1000'dir. Not: Bu işlem çalışırken nesneler değiştirilirse sonuçlar tutarlı olmayabilir. Uyarı: listAll çok fazla sonuç varsa potansiyel olarak çok fazla kaynak tüketebilir.
updateMetadata(ref, meta veriler) Bu nesnenin meta verilerini günceller.
uploadBytes(ref, veri, meta veri) Verileri bu nesnenin konumuna yükler. Yükleme devam ettirilemez.
uploadBytesResumable(ref, veri, meta veri) Verileri bu nesnenin konumuna yükler. Yükleme duraklatılabilir ve devam ettirilebilir ve ilerleme güncellemelerini ortaya çıkarır.
uploadString(ref, değer, format, meta veriler) Bu nesnenin konumuna bir dize yükler. Yükleme devam ettirilemez.
fonksiyon(storageOrRef, ...)
ref(storageOrRef, yol) Varsayılan pakette belirtilen yol için bir StorageReference döndürür.

Sınıflar

Sınıf Tanım
Depolama Hatası Firebase Depolama SDK'sının döndürdüğü bir hata.

Numaralandırmalar

Numaralandırma Tanım
DepolamaHatasıKodu StorageError nesnelerine eklenebilecek hata kodları.

Arayüzler

Arayüz Tanım
FirebaseDepolama Bir Firebase Storage örneği.
Tam Meta Veriler Salt okunur özellikler de dahil olmak üzere nesne meta verilerinin tamamı.
Liste Seçenekleri Seçenekler list() kabul eder.
ListeSonucu List() tarafından döndürülen sonuç.
AyarlanabilirMeta Veriler İstediğiniz zaman ayarlanabilen nesne meta verileri.
StorageObserver Firebase Storage için bir akış gözlemcisi.
DepolamaReferansı Bir Google Cloud Storage nesnesine başvuruyu temsil eder. Geliştiriciler nesneleri yükleyebilir, indirebilir ve silebilir, ayrıca nesne meta verilerini alabilir/ayarlayabilir.
Meta Verileri Yükle Yükleme sırasında ayarlanabilecek nesne meta verileri.
Sonucu Yükle Devam ettirilemeyen bir yüklemeden döndürülen sonuç.
YüklemeGörevi Bir nesneyi yükleme işlemini temsil eder. Yüklemeyi izlemenizi ve yönetmenizi sağlar.
Görev Anlık Görüntüsünü Yükle Yükleme görevinin mevcut durumuna ilişkin verileri tutar.

Değişkenler

Değişken Tanım
Dize Formatı Yükleme için olası dize biçimlerinin listesi.

Takma Adları Yazın

Takma Ad yazın Tanım
Dize Formatı Yükleme için olası dize biçimlerinin listesi.
Görev Olayı Bir görevde tetiklenen bir olay.
Görev Durumu Çalışan bir yüklemenin geçerli durumunu temsil eder.

işlev(uygulama, ...)

getStorage(app, BucketUrl)

Belirtilen Firebase uygulaması için bir FirebaseStorage örneği alır.

İmza:

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

Parametreler

Parametre Tip Tanım
uygulama Firebase Uygulaması FirebaseStorage örneğinin alınacağı Firebase uygulaması.
kovaUrl'si sicim Firebase Depolama Paketinizin gs:// URL'si. Geçilmezse uygulamanın varsayılan Depolama Paketini kullanır.

İadeler:

FirebaseDepolama

Bir FirebaseStorage örneği.

fonksiyon(depolama, ...)

connectStorageEmulator(depolama, ana bilgisayar, bağlantı noktası, seçenekler)

Cloud Storage emülatörüyle iletişim kurmak için bu FirebaseStorage örneğini değiştirin.

İmza:

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

Parametreler

Parametre Tip Tanım
depolamak FirebaseDepolama FirebaseStorage örneği
ev sahibi sicim Emülatör ana bilgisayarı (ör. localhost)
liman sayı Emülatör bağlantı noktası (ör. 5001)
seçenekler { MockUserToken?: EmulatorMockTokenOptions | sicim; } Emülatör seçenekleri. options.mockUserToken , Güvenlik Kurallarının birim testi için kullanılacak sahte kimlik doğrulama belirtecidir.

İadeler:

geçersiz

ref(depolama, url)

Verilen URL için bir StorageReference döndürür.

İmza:

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

Parametreler

Parametre Tip Tanım
depolamak FirebaseDepolama FirebaseStorage örneği.
URL sicim URL'si. Boşsa kök referansı döndürür.

İadeler:

DepolamaReferansı

fonksiyon(ref, ...)

deleteObject(ref)

Bu konumdaki nesneyi siler.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Silinecek nesne için StorageReference .

İadeler:

Söz<void>

Silme işleminin başarılı olması durumunda çözülecek bir Promise .

getBlob(ref, maxDownloadSizeBytes)

Verileri nesnenin konumuna indirir. Nesne bulunamazsa hata döndürür.

Bu işlevi kullanmak için uygulamanızın kaynağını Cloud Storage paketinizde beyaz listeye eklemeniz gerekir. Ayrıca bkz. https://cloud.google.com/storage/docs/configuring-cors

Bu API Node.js'de mevcut değil.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Verilerin indirilmesi gereken StorageReference.
maxDownloadSizeBytes sayı Ayarlanırsa, alınacak bayt cinsinden izin verilen maksimum boyut.

İadeler:

Söz<Blob>

Nesnenin baytlarını içeren bir Blob ile çözümlenen bir Promise

getBytes(ref, maxDownloadSizeBytes)

Verileri nesnenin konumuna indirir. Nesne bulunamazsa hata döndürür.

Bu işlevi kullanmak için uygulamanızın kaynağını Cloud Storage paketinizde beyaz listeye eklemeniz gerekir. Ayrıca bkz. https://cloud.google.com/storage/docs/configuring-cors

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Verilerin indirilmesi gereken StorageReference.
maxDownloadSizeBytes sayı Ayarlanırsa, alınacak bayt cinsinden izin verilen maksimum boyut.

İadeler:

Söz<ArrayBuffer>

Nesnenin baytlarını içeren bir Promise

getDownloadURL(ref)

Verilen StorageReference için indirme URL'sini döndürür .

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı İndirme URL'sini almak için StorageReference .

İadeler:

Söz<string>

Bu nesnenin indirme URL'siyle çözümlenen bir Promise .

getMetadata(ref)

Bu nesnenin meta verileriyle çözümlenen bir Promise . Bu nesne mevcut değilse veya meta veriler alınamıyorsa söz reddedilir.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Meta verilerin alınacağı StorageReference .

İadeler:

Söz< FullMetadata >

getStream(ref, maxDownloadSizeBytes)

Verileri nesnenin konumuna indirir. Nesne bulunamazsa bir hata olayı başlatır.

Bu API yalnızca Node.js'de mevcuttur.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Verilerin indirilmesi gereken StorageReference.
maxDownloadSizeBytes sayı Ayarlanırsa, alınacak bayt cinsinden izin verilen maksimum boyut.

İadeler:

NodeJS.ReadableStream

Nesnenin bayt cinsinden verilerini içeren bir akış

liste(ref, seçenekler)

Bu depolama referansı altındaki öğeleri (dosyaları) ve önekleri (klasörleri) listeleyin.

Liste API'si yalnızca Firebase Kuralları Sürüm 2 için kullanılabilir.

GCS bir anahtar bloğu deposudur. Firebase Storage, '/' sınırlandırılmış klasör yapısının anlamını uygular. Daha fazla bilgi edinmek istiyorsanız GCS'nin Liste API'sine bakın.

Firebase Kurallarının Semantiğine uymak için Firebase Storage, yolları "/" ile biten veya ardışık iki "/" içeren nesneleri desteklemez. Firebase Depolama Listesi API'si bu desteklenmeyen nesneleri filtreleyecektir. Pakette çok fazla desteklenmeyen nesne varsa list() başarısız olabilir.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Listenin alınacağı StorageReference .
seçenekler Liste Seçenekleri Ayrıntılar için ListOptions'a bakın.

İadeler:

Söz< ListeSonucu >

Öğeler ve öneklerle çözülen bir Promise . prefixes alt klasörlere referanslar içerir ve items bu klasördeki nesnelere referanslar içerir. nextPageToken sonuçların geri kalanını almak için kullanılabilir.

listeTümü(ref)

Bu depolama referansı altındaki tüm öğeleri (dosyaları) ve önekleri (klasörleri) listeleyin.

Bu, daha fazla sonuç kalmayıncaya kadar list() işlevinin tekrar tekrar çağrılmasına yönelik yardımcı bir yöntemdir. Varsayılan sayfalandırma boyutu 1000'dir.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Listenin alınacağı StorageReference .

İadeler:

Söz< ListeSonucu >

Geçerli depolama referansı altındaki tüm öğeler ve öneklerle çözümlenen bir Promise . prefixes alt dizinlere referanslar içerir ve items bu klasördeki nesnelere referanslar içerir. nextPageToken asla döndürülmez.

updateMetadata(ref, meta veriler)

Bu nesnenin meta verilerini günceller.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Meta verileri güncellemek için StorageReference .
meta veri AyarlanabilirMeta Veriler Nesnenin yeni meta verileri. Yalnızca açıkça ayarlanan değerler değiştirilecektir. Bir değerin açıkça null değerine ayarlanması meta verileri kaldıracaktır.

İadeler:

Söz< FullMetadata >

Bu nesne için yeni meta verilerle çözümlenen bir Promise .

uploadBytes(ref, veri, meta veri)

Verileri bu nesnenin konumuna yükler. Yükleme devam ettirilemez.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Verilerin yüklenmesi gereken StorageReference .
veri damla | Uint8Array | Dizi Tamponu Yüklenecek veriler.
meta veri Meta Verileri Yükle Yüklenecek verilere ilişkin meta veriler.

İadeler:

Söz< YüklemeSonucu >

UploadResult içeren bir Söz

uploadBytesResumable(ref, veri, meta veri)

Verileri bu nesnenin konumuna yükler. Yükleme duraklatılabilir ve devam ettirilebilir ve ilerleme güncellemelerini ortaya çıkarır.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Verilerin yüklenmesi gereken StorageReference .
veri damla | Uint8Array | Dizi Tamponu Yüklenecek veriler.
meta veri Meta Verileri Yükle Yüklenecek verilere ilişkin meta veriler.

İadeler:

YüklemeGörevi

Bir YüklemeGörevi

uploadString(ref, değer, format, meta veriler)

Bu nesnenin konumuna bir dize yükler. Yükleme devam ettirilemez.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DepolamaReferansı Dizenin yüklenmesi gereken StorageReference .
değer sicim Yüklenecek dize.
biçim Dize Formatı Yüklenecek dizenin biçimi.
meta veri Meta Verileri Yükle Yüklenecek dizenin meta verileri.

İadeler:

Söz< YüklemeSonucu >

UploadResult içeren bir Söz

fonksiyon(storageOrRef, ...)

ref(storageOrRef, yol)

Varsayılan pakette belirtilen yol için bir StorageReference döndürür.

İmza:

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

Parametreler

Parametre Tip Tanım
depolamaOrRef FirebaseDepolama | DepolamaReferansı FirebaseStorage veya StorageReference .
yol sicim

İadeler:

DepolamaReferansı

Dize Formatı

Yükleme için olası dize biçimlerinin listesi.

İmza:

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

Dize Formatı

Yükleme için olası dize biçimlerinin listesi.

İmza:

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

Görev Olayı

Bir görevde tetiklenen bir olay.

İmza:

export declare type TaskEvent = 'state_changed';

Görev Durumu

Çalışan bir yüklemenin geçerli durumunu temsil eder.

İmza:

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

DepolamaHatasıKodu

StorageError nesnelerine eklenebilecek hata kodları.

İmza:

export declare enum StorageErrorCode

Numaralandırma Üyeleri

Üye Değer Tanım
APP_DELETED "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
İPTAL EDİLDİ "canceled"
_SLICE_BLOB YAPILMAZ "cannot-slice-blob"
İÇ HATA "internal-error"
GEÇERSİZ ARGÜMAN "invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
INVALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
GEÇERSİZ FORMAT "invalid-format"
INVALID_ROOT_OPERATION "invalid-root-operation"
GEÇERSİZ URL "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
NESNE BULUNAMADI "object-not-found"
PROJECT_NOT_FOUND "project-not-found"
KOTA AŞILDI "quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
DOĞRULANMAMIŞ "unauthenticated"
YETKİSİZ "unauthorized"
UNAUTHORIZED_APP "unauthorized-app"
BİLİNMEYEN "unknown"
UNSUPPORTED_ENVIRONMENT "unsupported-environment"