storage package

Magazyn w chmurze dla Firebase

Funkcje

Zajęcia

Wyliczenia

Interfejsy

Zmienne

Wpisz aliasy

funkcja (aplikacja, ...)

getStorage(aplikacja, BucketUrl)

Pobiera instancję FirebaseStorage dla danej aplikacji Firebase.

Podpis:

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

Parametry

Zwroty:

Magazyn Firebase

Instancja FirebaseStorage .

funkcja (przechowywanie, ...)

connectStorageEmulator (pamięć, host, port, opcje)

Zmodyfikuj tę instancję FirebaseStorage , aby komunikowała się z emulatorem Cloud Storage.

Podpis:

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

Parametry

Zwroty:

próżnia

ref(pamięć, adres URL)

Zwraca StorageReference dla podanego adresu URL.

Podpis:

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

Parametry

Zwroty:

Odniesienie do przechowywania

funkcja(ref, ...)

usuńobiekt(ref)

Usuwa obiekt w tej lokalizacji.

Podpis:

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

Parametry

Zwroty:

Obietnica<pusta>

Promise , która rozwiązuje się, jeśli usunięcie się powiedzie.

getBlob(ref, maxDownloadSizeBytes)

Pobiera dane z lokalizacji obiektu. Zwraca błąd, jeśli obiekt nie został znaleziony.

Aby skorzystać z tej funkcji, musisz dodać pochodzenie swojej aplikacji do białej listy w swoim zasobniku Cloud Storage. Zobacz także https://cloud.google.com/storage/docs/configuring-cors

Ten interfejs API nie jest dostępny w Node.

Podpis:

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

Parametry

Zwroty:

Obiecaj<Blob>

Obietnica, która jest rozpoznawana za pomocą obiektu Blob zawierającego bajty obiektu

getBytes(ref, maxDownloadSizeBytes)

Pobiera dane z lokalizacji obiektu. Zwraca błąd, jeśli obiekt nie został znaleziony.

Aby skorzystać z tej funkcji, musisz dodać pochodzenie swojej aplikacji do białej listy w swoim zasobniku Cloud Storage. Zobacz także https://cloud.google.com/storage/docs/configuring-cors

Podpis:

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

Parametry

Zwroty:

Obietnica<ArrayBuffer>

Promise zawierający bajty obiektu

pobierzURL pobierania(ref)

Zwraca adres URL pobierania dla danego StorageReference .

Podpis:

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

Parametry

Zwroty:

Obietnica<string>

Promise , która rozwiązuje się wraz z adresem URL pobierania tego obiektu.

pobierzMetadane(ref)

Promise , która jest rozpoznawana z metadanymi tego obiektu. Jeśli ten obiekt nie istnieje lub nie można odzyskać metadanych, obietnica zostaje odrzucona.

Podpis:

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

Parametry

Zwroty:

Obietnica< FullMetadata >

getStream(ref, maxDownloadSizeBytes)

Pobiera dane z lokalizacji obiektu. Wywołuje zdarzenie błędu, jeśli obiekt nie zostanie znaleziony.

Ten interfejs API jest dostępny tylko w Node.

Podpis:

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

Parametry

Zwroty:

Strumień NodeJS.Readable

Strumień z danymi obiektu w postaci bajtów

lista(ref, opcje)

Wyświetl listę elementów (plików) i przedrostków (folderów) w ramach tego odniesienia do przechowywania.

List API jest dostępny tylko dla reguł Firebase w wersji 2.

GCS to magazyn kluczy. Firebase Storage narzuca semantykę struktury folderów rozdzielanych znakiem „/”. Jeśli chcesz dowiedzieć się więcej, zobacz interfejs API listy GCS.

Aby zachować zgodność z semantyką reguł Firebase, Firebase Storage nie obsługuje obiektów, których ścieżki kończą się na „/” lub zawierają dwa kolejne „/”. Interfejs API listy pamięci Firebase odfiltruje te nieobsługiwane obiekty. list() może się nie powieść, jeśli w wiadrze znajduje się zbyt wiele nieobsługiwanych obiektów.

Podpis:

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

Parametry

Zwroty:

Obietnica< ListResult >

Promise rozwiązywana za pomocą przedmiotów i przedrostków. prefixes zawiera odniesienia do podfolderów, a items zawierają odniesienia do obiektów w tym folderze. nextPageToken można wykorzystać do uzyskania pozostałych wyników.

listawszystkich(ref)

Wypisz wszystkie elementy (pliki) i przedrostki (foldery) w ramach tego odniesienia do przechowywania.

Jest to metoda pomocnicza służąca do wielokrotnego wywoływania funkcji list() do momentu wyczerpania się wyników. Domyślny rozmiar paginacji to 1000.

Podpis:

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

Parametry

Zwroty:

Obietnica< ListResult >

Promise , która jest rozpatrywana ze wszystkimi przedmiotami i przedrostkami w ramach bieżącego odniesienia do magazynu. prefixes zawiera odniesienia do podkatalogów, a items zawierają odniesienia do obiektów w tym folderze. nextPageToken nigdy nie jest zwracany.

updateMetadata(ref, metadane)

Aktualizuje metadane dla tego obiektu.

Podpis:

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

Parametry

Zwroty:

Obietnica< FullMetadata >

Promise , która zostanie rozwiązana z nowymi metadanymi dla tego obiektu.

uploadBytes(ref, dane, metadane)

Przesyła dane o lokalizacji tego obiektu. Przesyłania nie można wznowić.

Podpis:

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

Parametry

Zwroty:

Obietnica< Wynik przesłania >

Obietnica zawierająca wynik przesyłania

uploadBytesResumable(ref, dane, metadane)

Przesyła dane o lokalizacji tego obiektu. Przesyłanie można wstrzymywać i wznawiać, wyświetlając aktualizacje postępu.

Podpis:

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

Parametry

Zwroty:

Prześlij zadanie

Zadanie przesyłania

uploadString(ref, wartość, format, metadane)

Przesyła ciąg do lokalizacji tego obiektu. Przesyłania nie można wznowić.

Podpis:

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

Parametry

Zwroty:

Obietnica< Wynik przesłania >

Obietnica zawierająca wynik przesyłania

funkcja(storageOrRef, ...)

ref(storageOrRef, ścieżka)

Zwraca StorageReference dla podanej ścieżki w zasobniku domyślnym.

Podpis:

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

Parametry

Zwroty:

Odniesienie do przechowywania

Format ciągu

Wyliczenie możliwych formatów ciągów do przesłania.

Podpis:

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

Format ciągu

Wyliczenie możliwych formatów ciągów do przesłania.

Podpis:

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

ZadanieZdarzenie

Zdarzenie wyzwalane w zadaniu.

Podpis:

export declare type TaskEvent = 'state_changed';

Stan zadania

Reprezentuje bieżący stan uruchomionego przesyłania.

Podpis:

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

Kod błędu przechowywania

Kody błędów, które można dołączyć do obiektów StorageError .

Podpis:

export declare enum StorageErrorCode 

Członkowie wyliczenia