Magazyn w chmurze dla Firebase
Funkcje
Funkcjonować | Opis |
---|---|
funkcja (aplikacja, ...) | |
getStorage(aplikacja, BucketUrl) | Pobiera instancję FirebaseStorage dla danej aplikacji Firebase. |
funkcja (przechowywanie, ...) | |
connectStorageEmulator (pamięć, host, port, opcje) | Zmodyfikuj tę instancję FirebaseStorage , aby komunikowała się z emulatorem Cloud Storage. |
ref(pamięć, adres URL) | Zwraca StorageReference dla podanego adresu URL. |
funkcja(ref, ...) | |
usuńobiekt(ref) | Usuwa obiekt w tej lokalizacji. |
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. |
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 |
pobierzURL pobierania(ref) | Zwraca adres URL pobierania dla danego StorageReference . |
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. |
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. |
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. |
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. Uwaga: Wyniki mogą nie być spójne, jeśli obiekty zostaną zmienione w trakcie wykonywania tej operacji. Ostrzeżenie: listAll może potencjalnie zużyć zbyt wiele zasobów, jeśli jest zbyt wiele wyników. |
updateMetadata(ref, metadane) | Aktualizuje metadane dla tego obiektu. |
uploadBytes(ref, dane, metadane) | Przesyła dane o lokalizacji tego obiektu. Przesyłania nie można wznowić. |
uploadBytesResumable(ref, dane, metadane) | Przesyła dane o lokalizacji tego obiektu. Przesyłanie można wstrzymywać i wznawiać, wyświetlając aktualizacje postępu. |
uploadString(ref, wartość, format, metadane) | Przesyła ciąg do lokalizacji tego obiektu. Przesyłania nie można wznowić. |
funkcja(storageOrRef, ...) | |
ref(storageOrRef, ścieżka) | Zwraca StorageReference dla podanej ścieżki w zasobniku domyślnym. |
Zajęcia
Klasa | Opis |
---|---|
Błąd przechowywania | Błąd zwrócony przez pakiet SDK Firebase Storage. |
Wyliczenia
Wyliczenie | Opis |
---|---|
Kod błędu przechowywania | Kody błędów, które można dołączyć do obiektów StorageError . |
Interfejsy
Interfejs | Opis |
---|---|
Magazyn Firebase | Instancja Firebase Storage. |
Pełne metadane | Pełny zestaw metadanych obiektów, w tym właściwości tylko do odczytu. |
Opcje listy | list() akceptuje. |
ListaWyników | Wynik zwrócony przez list(). |
UstawialneMetadane | Metadane obiektu, które można ustawić w dowolnym momencie. |
Obserwator pamięci masowej | Obserwator strumienia dla Firebase Storage. |
Odniesienie do przechowywania | Reprezentuje odwołanie do obiektu Google Cloud Storage. Programiści mogą przesyłać, pobierać i usuwać obiekty, a także pobierać/ustawiać metadane obiektów. |
PrześlijMetadane | Metadane obiektu, które można ustawić podczas przesyłania. |
Prześlij wynik | Wynik zwrócony z przesyłania, którego nie można wznowić. |
Prześlij zadanie | Reprezentuje proces przekazywania obiektu. Umożliwia monitorowanie i zarządzanie przesyłaniem. |
Prześlij migawkę zadania | Przechowuje dane o bieżącym stanie zadania przesyłania. |
Zmienne
Zmienny | Opis |
---|---|
Format ciągu | Wyliczenie możliwych formatów ciągów do przesłania. |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
Format ciągu | Wyliczenie możliwych formatów ciągów do przesłania. |
ZadanieZdarzenie | Zdarzenie wyzwalane w zadaniu. |
Stan zadania | Reprezentuje bieżący stan uruchomionego przesyłania. |
funkcja (aplikacja, ...)
getStorage(aplikacja, BucketUrl)
Pobiera instancję FirebaseStorage dla danej aplikacji Firebase.
Podpis:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja Firebase | Aplikacja Firebase, dla której można uzyskać instancję FirebaseStorage . |
wiadroUrl | strunowy | Adres URL gs:// do zasobnika pamięci Firebase. Jeśli nie zostanie zaliczony, korzysta z domyślnego zasobnika pamięci aplikacji. |
Zwroty:
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
Parametr | Typ | Opis |
---|---|---|
składowanie | Magazyn Firebase | Instancja FirebaseStorage |
gospodarz | strunowy | Host emulatora (np. localhost) |
Port | numer | Port emulatora (np. 5001) |
opcje | { mockUserToken?: EmulatorMockTokenOptions | strunowy; } | Opcje emulatora. options.mockUserToken to próbny token uwierzytelniania używany do testowania jednostkowego reguł bezpieczeństwa. |
Zwroty:
próżnia
ref(pamięć, adres URL)
Zwraca StorageReference dla podanego adresu URL.
Podpis:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
Parametry
Parametr | Typ | Opis |
---|---|---|
składowanie | Magazyn Firebase | Instancja FirebaseStorage . |
adres URL | strunowy | Adres URL. Jeśli puste, zwraca odwołanie do katalogu głównego. |
Zwroty:
funkcja(ref, ...)
usuńobiekt(ref)
Usuwa obiekt w tej lokalizacji.
Podpis:
export declare function deleteObject(ref: StorageReference): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference dla obiektu do usunięcia. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference, gdzie należy pobrać dane. |
maxDownloadSizeBytes | numer | Jeśli jest ustawiony, maksymalny dozwolony rozmiar w bajtach do pobrania. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference, gdzie należy pobrać dane. |
maxDownloadSizeBytes | numer | Jeśli jest ustawiony, maksymalny dozwolony rozmiar w bajtach do pobrania. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference , aby uzyskać adres URL pobierania. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference, z którego można uzyskać metadane. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference, gdzie należy pobrać dane. |
maxDownloadSizeBytes | numer | Jeśli jest ustawiony, maksymalny dozwolony rozmiar w bajtach do pobrania. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference, z którego można pobrać listę. |
opcje | Opcje listy | Aby uzyskać szczegółowe informacje, zobacz ListOptions . |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference, z którego można pobrać listę. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference , dla którego chcesz zaktualizować metadane. |
metadane | UstawialneMetadane | Nowe metadane obiektu. Zmienione zostaną tylko wartości, które zostały jawnie ustawione. Jawne ustawienie wartości null spowoduje usunięcie metadanych. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference , do którego należy przesłać dane. |
dane | Kropla | Uint8Array | Bufor tablicy | Dane do przesłania. |
metadane | PrześlijMetadane | Metadane danych do przesłania. |
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference , do którego należy przesłać dane. |
dane | Kropla | Uint8Array | Bufor tablicy | Dane do przesłania. |
metadane | PrześlijMetadane | Metadane danych do przesłania. |
Zwroty:
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
Parametr | Typ | Opis |
---|---|---|
ref | Odniesienie do przechowywania | StorageReference , do którego należy przesłać ciąg. |
wartość | strunowy | Ciąg do przesłania. |
format | Format ciągu | Format ciągu do przesłania. |
metadane | PrześlijMetadane | Metadane ciągu do przesłania. |
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
Parametr | Typ | Opis |
---|---|---|
przechowywanieOrRef | Magazyn Firebase | Odniesienie do przechowywania | FirebaseStorage lub StorageReference . |
ścieżka | strunowy |
Zwroty:
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
Członek | Wartość | Opis |
---|---|---|
APLIKACJA_USUNIĘTA | "app-deleted" | |
BUCKET_NOT_FOUND | "bucket-not-found" | |
ODWOŁANY | "canceled" | |
CANNOT_SLICE_BLOB | "cannot-slice-blob" | |
BŁĄD WEWNĘTRZNY | "internal-error" | |
BŁĘDNY ARGUMENT | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
NIEPOPRAWNY FORMAT | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
NIEPRAWIDŁOWY URL | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
NO_DOWNLOAD_URL | "no-download-url" | |
OBIEKT NIE ZNALEZIONY | "object-not-found" | |
PROJEKT_NOT_FOUND | "project-not-found" | |
MOZLIWA ILOŚĆ PRZEKROCZONA | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVER_FILE_WRONG_SIZE | "server-file-wrong-size" | |
NIEUWIERZYTELNIONE | "unauthenticated" | |
NIEAUTORYZOWANY | "unauthorized" | |
NIEAUTORYZOWANA_APLIKACJA | "unauthorized-app" | |
NIEZNANY | "unknown" | |
UNSUPPORTED_ENVIRONMENT | "unsupported-environment" |