storage package

Cloud Storage dla Firebase

Funkcje

Zajęcia

Wyliczenia

Interfejsy

Zmienne

Aliasy typu

funkcja(aplikacja, ...)

getStorage(aplikacja;bucketUrl)

Pobiera instancję FirebaseStorage dla danej aplikacji Firebase.

Podpis:

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

Parametry

Zwroty:

FirebaseStorage

Instancja FirebaseStorage.

funkcja(miejsce na dane, ...)

ConnectStorageEmulator(miejsce na dane, host, port, opcje)

Zmodyfikuj instancję FirebaseStorage, aby komunikować się z emulatorem Cloud Storage.

Podpis:

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

Parametry

Zwroty:

nieważne

ref(miejsce na dane; url)

Zwraca StorageReference dla podanego adresu URL.

Podpis:

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

Parametry

Zwroty:

StorageReference

funkcja(ref, ...)

deleteObject(ref)

Usuwa obiekt w tej lokalizacji.

Podpis:

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

Parametry

Zwroty:

Obietnica<void>

Promise, który wyłącza się po usunięciu.

getBlob(ref, maxDownloadSizeBytes)

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

Aby korzystać z tej funkcji, musisz dodać źródło aplikacji do białej listy w zasobniku Cloud Storage. Zobacz też https://cloud.google.com/storage/docs/configuring-cors

Ten interfejs API jest niedostępny w Node.

Podpis:

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

Parametry

Zwroty:

Obietnica<Blob>

Obietnica, którą można zrealizować 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 korzystać z tej funkcji, musisz dodać źródło aplikacji do białej listy w zasobniku Cloud Storage. Zobacz też https://cloud.google.com/storage/docs/configuring-cors

Podpis:

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

Parametry

Zwroty:

Obietnica<tablicaBuffer>

Obietnica zawierająca bajty obiektu

getDownloadURL(ref)

Zwraca adres URL pobierania dla podanego elementu StorageReference.

Podpis:

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

Parametry

Zwroty:

Obietnica<ciąg>

Identyfikator Promise, który prowadzi do adresu URL pobierania tego obiektu.

getMetadata(ref)

Identyfikator Promise, który określa się z metadanymi tego obiektu. Jeśli ten obiekt nie istnieje lub nie można pobrać metadanych, obietnica zostanie 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): ReadableStream;

Parametry

Zwroty:

Strumień do odczytu

Strumień z danymi obiektu w postaci bajtów

list(ref, opcje)

Wyświetl listę elementów (plików) i prefiksów (folderów) w tym odniesieniu do miejsca na dane.

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

GCS to magazyn blobów kluczy. Usługa Firebase Storage nakłada semantykę znaku „/” struktura folderów rozdzielanych znakami Aby dowiedzieć się więcej, zapoznaj się z interfejsem List API w GCS.

Zgodnie z semantyką reguł Firebase, Firebase Storage nie obsługuje obiektów, których ścieżki kończą się znakiem „/” lub zawierają dwa następujące po sobie znaki „/”. Interfejs Firebase Storage List API odfiltruje te nieobsługiwane obiekty. lista() może się nie udać, jeśli w zasobniku znajduje się zbyt wiele nieobsługiwanych obiektów.

Podpis:

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

Parametry

Zwroty:

Obietnica<ListResult>

Identyfikator Promise, który odnosi się do elementów i prefiksów. prefixes zawiera odwołania do podfolderów, a items zawiera odwołania do obiektów w tym folderze. Aby uzyskać pozostałe wyniki, możesz użyć parametru nextPageToken.

listaAll(ref)

Wymień wszystkie elementy (pliki) i prefiksy (foldery) w tym odniesieniu do miejsca na dane.

Jest to metoda pomocnicza do wielokrotnego wywoływania listy() do momentu, gdy nie ma więcej wyników. Domyślny rozmiar podziału na strony to 1000.

Podpis:

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

Parametry

Zwroty:

Obietnica<ListResult>

Promise, który występuje przy użyciu wszystkich elementów i prefiksów w bieżącym odniesieniu do miejsca na dane. prefixes zawiera odwołania do podkatalogów, a items zawiera odwołania do obiektów w tym folderze. Parametr nextPageToken nigdy nie jest zwracany.

updateMetadata(ref; metadane)

Aktualizuje metadane tego obiektu.

Podpis:

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

Parametry

Zwroty:

Obietnica<FullMetadata>

Identyfikator Promise, który jest rozpoznawany z nowymi metadanymi tego obiektu.

sendBytes(ref; dane; metadane)

Służy do przesyłania danych do lokalizacji tego obiektu. Nie można wznowić przesyłania.

Podpis:

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

Parametry

Zwroty:

Obietnica<UploadResult>

Obietnica zawierająca wynik przesyłania

sendBytesResumable(ref; dane; metadane)

Służy do przesyłania danych do lokalizacji tego obiektu. Przesyłanie można wstrzymać i wznowić. Zobaczysz też informacje o postępach.

Podpis:

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

Parametry

Zwroty:

UploadTask

Zadanie przesyłania

PrześlijString(ref; wartość; format; metadane)

Przesyła ciąg znaków do lokalizacji tego obiektu. Nie można wznowić przesyłania.

Podpis:

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

Parametry

Zwroty:

Obietnica<UploadResult>

Obietnica zawierająca wynik przesyłania

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

StorageReference

StringFormat

Lista możliwych formatów ciągów tekstowych, które można przesłać.

Podpis:

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

StringFormat

Lista możliwych formatów ciągów tekstowych, które można przesłać.

Podpis:

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

Zdarzenie zadania

Zdarzenie wywoływane w zadaniu.

Podpis:

export declare type TaskEvent = 'state_changed';

Stan zadania

Reprezentuje bieżący stan trwającego przesyłania.

Podpis:

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

Kod błędu pamięci masowej

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

Podpis:

export declare enum StorageErrorCode 

Członkowie wyliczenia