storage package

Cloud Storage for Firebase

İşlevler

Sınıflar

Numaralandırmalar

Arayüzler

Değişkenler

Tür Takma Adları

function(uygulama; ...)

getStorage(uygulama; paketUrl)

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

İmza:

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

Parametreler

Şunu döndürür:

FirebaseStorage

FirebaseStorage örneği.

function(depolama; ...)

ConnectStorageEmulator(depolama; ana makine, 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

Şunu döndürür:

geçersiz

ref(depolama; url)

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

İmza:

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

Parametreler

Şunu döndürür:

StorageReference

function(ref; ...)

deleteObject(başvuru)

Bu konumdaki nesneyi siler.

İmza:

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

Parametreler

Şunu döndürür:

Taahhüt<void>

Silme işlemi başarılı olursa çözümlenen bir Promise.

getBlob(ref; maxDownloadSizeBytes)

Nesnenin konumundaki verileri indirir. Nesne bulunmazsa hata döndürür.

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

Bu API, Düğüm'de kullanılamıyor.

İmza:

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

Parametreler

Şunu döndürür:

Söz veriyorum<Blob>

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

getBytes(ref, maxDownloadSizeBytes)

Nesnenin konumundaki verileri indirir. Nesne bulunmazsa hata döndürür.

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

İmza:

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

Parametreler

Şunu döndürür:

Promise<ArrayBuffer>

Nesnenin baytlarını içeren bir Promise

getDownloadURL(ref)

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

İmza:

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

Parametreler

Şunu döndürür:

Promise<dize>

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

getMetadata(ref)

Bu nesnenin meta verileriyle çözümlenen bir Promise. Bu nesne yoksa veya meta veriler alınamıyorsa taahhüt reddedilir.

İmza:

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

Parametreler

Şunu döndürür:

Promise<FullMetadata>

getStream(ref; maxDownloadSizeBytes)

Nesnenin konumundaki verileri indirir. Nesne bulunamazsa bir hata etkinliği oluşturur.

Bu API yalnızca Düğüm'de kullanılabilir.

İmza:

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

Parametreler

Şunu döndürür:

Okunabilir Akış

Nesnenin verilerini bayt biçiminde içeren bir akış

list(ref; options)

Bu depolama alanı referansı altındaki öğeleri (dosyalar) ve ön ekleri (klasörler) listeleyin.

List API yalnızca Firebase Kuralları Sürüm 2'de kullanılabilir.

GCS, bir anahtar blob deposudur. Firebase Storage, "/" anlamını uygular ayrılmaz bir klasör yapısı vardır. Daha fazla bilgi edinmek için GCS'nin List API'sine göz atın.

Firebase Kurallarının Semantiği'ne uymak için Firebase Storage, yolları "/" ile biten nesneleri desteklemez ya da art arda iki "/" işareti içermelidir. Firebase Storage List API, desteklenmeyen bu nesneleri filtreler. Pakette çok fazla desteklenmeyen nesne varsa list() başarısız olabilir.

İmza:

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

Parametreler

Şunu döndürür:

Promise<ListResult>

Öğeler ve ön eklerle çözümlenen bir Promise. prefixes alt klasörlere ve items bu klasördeki nesnelere referanslar içeriyor. nextPageToken, diğer sonuçları almak için kullanılabilir.

listAll(ref)

Bu depolama alanı referansındaki tüm öğeleri (dosyalar) ve ön ekleri (klasörler) listeleyin.

Bu, başka sonuç kalmayana kadar list() çağrısının tekrar tekrar yapılması için yardımcı bir yöntemdir. Sayfalandırma boyutu varsayılan olarak 1.000'dir.

İmza:

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

Parametreler

Şunu döndürür:

Promise<ListResult>

Geçerli depolama referansı altındaki tüm öğeler ve ön eklerle çözümlenen bir Promise. prefixes alt dizinlere, items ise bu klasördeki nesnelere referanslar içeriyor. nextPageToken asla iade edilmez.

updateMetadata(ref, meta veriler)

Bu nesnenin meta verilerini günceller.

İmza:

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

Parametreler

Şunu döndürür:

Promise<FullMetadata>

Bu nesnenin yeni meta verileriyle çözümlenen bir Promise.

installBytes(ref; veriler; meta veriler)

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

İmza:

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

Parametreler

Şunu döndürür:

Promise<UploadResult>

UploadResult içeren bir Vaat

UploadBytesResumable(ref; veriler; meta veriler)

Verileri bu nesnenin konumuna yükler. Yükleme duraklatılıp devam ettirilebilir ve ilerleme durumu güncellemeleri gösterilir.

İmza:

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

Parametreler

Şunu döndürür:

UploadTask

Yükleme Görevi

installString(ref; değer; biçim; meta veriler)

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

İmza:

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

Parametreler

Şunu döndürür:

Promise<UploadResult>

UploadResult içeren bir Vaat

function(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

Şunu döndürür:

StorageReference

Dize Biçimi

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 Biçimi

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

İmza:

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

Görev Etkinliği

Bir görevde tetiklenen etkinlik.

İmza:

export declare type TaskEvent = 'state_changed';

Görev Durumu

Çalışmakta olan bir yüklemenin mevcut durumunu temsil eder.

İmza:

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

Depolama Hata Kodu

StorageError nesneye eklenebilecek hata kodları.

İmza:

export declare enum StorageErrorCode 

Numaralandırma Üyeleri