storage package

Cloud Storage dla Firebase

Funkcje

Funkcja	Opis
function(aplikacja, ...)
getStorage(app;bucketUrl)	Pobiera instancję FirebaseStorage dla danej aplikacji Firebase.
function(storage, ...)
connectStorageEmulator(miejsce na dane, host, port, opcje)	Zmodyfikuj instancję FirebaseStorage, aby komunikować się z emulatorem Cloud Storage.
ref(storage, url)	Zwraca StorageReference dla podanego adresu URL.
function(ref, ...)
deleteObject(ref)	Usuwa obiekt w tej lokalizacji.
getBlob(ref, maxDownloadSizeBytes)	Pobiera dane z lokalizacji obiektu. Zwraca błąd, jeśli obiekt nie został znaleziony.Aby użyć 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-corsTen interfejs API jest niedostępny w Node.
getBytes(ref, maxDownloadSizeBytes)	Pobiera dane z lokalizacji obiektu. Zwraca błąd, jeśli obiekt nie został znaleziony.Aby użyć 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
getDownloadURL(ref)	Zwraca adres URL pobierania dla podanego elementu StorageReference.
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.
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 węźle.
list(ref; opcje)	Wyświetlanie listy 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 kluczy-blob. Usługa Firebase Storage nakłada semantykę znaku „/” struktura folderów rozdzielanych znakami Jeśli chcesz dowiedzieć się więcej, zapoznaj się z interfejsem List API GCS.Aby zachować zgodność 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.
listAll(ref),	Wyświetl wszystkie elementy (pliki) i prefiksy (foldery) w tym odniesieniu do miejsca na dane.Jest to metoda pomocnicza do wielokrotnego wywoływania listy(), aż nie będzie więcej wyników. Domyślny rozmiar podziału na strony to 1000.Uwaga: wyniki mogą być niespójne, jeśli obiekty są zmieniane podczas wykonywania tej operacji.Ostrzeżenie: listAll może zużywać zbyt wiele zasobów, jeśli otrzyma zbyt wiele wyników.
updateMetadata(ref; metadane)	Aktualizuje metadane tego obiektu.
uploadBytes(ref; dane; metadane)	Służy do przesyłania danych do lokalizacji tego obiektu. Nie można wznowić przesyłania.
uploadBytesResumable(ref, data, metadata)	Służy do przesyłania danych do lokalizacji tego obiektu. Przesyłanie można wstrzymać i wznowić. Zobaczysz też informacje o postępach.
uploadString(ref; value, format, metadata)	Przesyła ciąg znaków do lokalizacji tego obiektu. Nie można wznowić przesyłania.
function(storageOrRef, ...)
ref(storageOrRef, ścieżka)	Zwraca StorageReference dla podanej ścieżki w zasobniku domyślnym.

Zajęcia

Klasa	Opis
Błąd pamięci	Błąd zwrócony przez pakiet SDK Firebase Storage.

Wyliczenia

Wyliczenie	Opis
Kod błędu pamięci masowej	Kody błędów, które można dołączyć do StorageError obiektów.

Interfejsy

Interfejs	Opis
FirebaseStorage	instancji Storage Storage.
FullMetadata	Pełny zestaw metadanych obiektu, w tym właściwości tylko do odczytu.
ListOptions,	Opcje akceptowane przez: list().
ListResult	Wynik zwrócony przez list().
SettableMetadata	Metadane obiektu, które można ustawić w dowolnym momencie.
StorageObserver,	Obserwator strumienia dla Firebase Storage.
StorageReference	Reprezentuje odwołanie do obiektu Google Cloud Storage. Programiści mogą przesyłać, pobierać i usuwać obiekty, a także pobierać i ustawiać metadane obiektów.
UploadMetadata	Metadane obiektu, które można ustawić podczas przesyłania.
UploadResult (Prześlij wynik)	Wynik zwrócony w wyniku przesyłania, którego nie można wznowić.
UploadTask	Reprezentuje proces przesyłania obiektu. Umożliwia monitorowanie przesyłania i zarządzanie nim.
UploadTaskSnapshot (Prześlij zrzut ekranu)	Przechowuje dane o bieżącym stanie zadania przesyłania.

Zmienne

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

Aliasy typu

Wpisz alias	Opis
StringFormat	Lista możliwych formatów ciągów tekstowych, które można przesłać.
TaskEvent	Zdarzenie wywoływane w zadaniu.
TaskState	Reprezentuje bieżący stan trwającego 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	aplikację Firebase, dla której chcesz pobrać instancję FirebaseStorage.
adres URL zasobnika	ciąg znaków	Adres URL gs:// do zasobnika Cloud Storage. Jeśli nie zostanie zaliczona, używany będzie domyślny zasobnik na dane aplikacji.

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

Parametr	Typ	Opis
magazynowanie	FirebaseStorage	Instancja FirebaseStorage
host	ciąg znaków	Host emulatora (np. localhost)
port	liczba	Port emulatora (np. 5001).
opcje	{ mockUserToken?: EmulatorMockTokenOptions | string;	Opcje emulatora. options.mockUserToken to przykładowy token uwierzytelniania używany do testowania jednostkowego reguł zabezpieczeń.

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

Parametr	Typ	Opis
magazynowanie	FirebaseStorage	instancji FirebaseStorage.
url (adres URL)	ciąg znaków	Adres URL. Jeśli pole jest puste, zwraca odwołanie do poziomu głównego.

Zwroty:

StorageReference

funkcja(ref, ...)

deleteObject(ref)

Usuwa obiekt w tej lokalizacji.

Podpis:

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

Parametry

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference dla obiektu do usunięcia.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, do której należy pobrać dane.
maxDownloadSizeBytes	liczba	Jeśli jest ustawiony, maksymalny dozwolony rozmiar (w bajtach) do pobrania.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, do której należy pobrać dane.
maxDownloadSizeBytes	liczba	Jeśli jest ustawiony, maksymalny dozwolony rozmiar (w bajtach) do pobrania.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, aby pobrać adres URL pobierania.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, z której pobierane są 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): ReadableStream;

Parametry

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, do której należy pobrać dane.
maxDownloadSizeBytes	liczba	Jeśli jest ustawiony, maksymalny dozwolony rozmiar (w bajtach) do pobrania.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, z której ma zostać pobrana lista.
opcje	ListOptions,	Szczegółowe informacje znajdziesz w sekcji ListOptions.

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.

Uwaga: wyniki mogą być niespójne, jeśli obiekty są zmieniane podczas wykonywania tej operacji.

Ostrzeżenie: usługa listAll może potencjalnie zużywać zbyt wiele zasobów, jeśli zostanie zwróconych zbyt wiele wyników.

Podpis:

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

Parametry

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, z której ma zostać pobrana lista.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, aby zaktualizować metadane.
metadane	SettableMetadata	Nowe metadane obiektu. Zmienione zostaną tylko wartości, które są wyraźnie ustawione. Jawne ustawienie wartości null powoduje usunięcie metadanych.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, do którego należy przesłać dane.
dane	Blob | Uint8tablica | SlateBuffer	Dane do przesłania.
metadane	UploadMetadata	Metadane danych do przesłania.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, do którego należy przesłać dane.
dane	Blob | Uint8tablica | SlateBuffer	Dane do przesłania.
metadane	UploadMetadata	Metadane danych do przesłania.

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

Parametr	Typ	Opis
odsyłacz	StorageReference	StorageReference, gdzie należy przesłać ciąg znaków.
wartość	ciąg znaków	Ciąg tekstowy do przesłania.
format	StringFormat	Format ciągu znaków do przesłania.
metadane	UploadMetadata	Metadane ciągu znaków do przesłania.

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

Parametr	Typ	Opis
StorageOrRef	FirebaseStorage | Odniesienie do pamięci masowej	FirebaseStorage lub StorageReference.
ścieżka	ciąg znaków

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

Członek	Wartość	Opis
USUNIĘTO	"app-deleted"
ZASOBNIK_NIE ZNALEZIONO	"bucket-not-found"
ODWOŁANY	"canceled"
CANNOT_SLICE_BLOB	"cannot-slice-blob"
BŁĄD_WEWNĘTRZNY	"internal-error"
NIEPRAWIDŁOWY_ARG	"invalid-argument"
Błędny_ARG_COUNT	"invalid-argument-count"
NIEPRAWIDŁOWA_SUMA KONTROLNA	"invalid-checksum"
NIEPRAWIDŁOWY_ZASOBNIK_DOMYŚLNY	"invalid-default-bucket"
NIEPRAWIDŁOWE_ZDARZENIE_NAZWA_ZDARZENIA	"invalid-event-name"
NIEPRAWIDŁOWY_FORMAT	"invalid-format"
NIEPRAWIDŁOWA_OPERACJA_ROOTA	"invalid-root-operation"
NIEPRAWIDŁOWY_URL	"invalid-url"
NO_DEFAULT_ZASOBNIK	"no-default-bucket"
BRAK_POBRANIA_URL-A	"no-download-url"
OBJECT_NOT_FOUND (Nie znaleziono obiektu)	"object-not-found"
NIE ZNALEZIONO PROJEKTU	"project-not-found"
QUOTA_EXCEEDED (PRZEKROCZONO)	"quota-exceeded"
PRZEKROCZONO_PONOWNIE_LIMIT	"retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE (rozmiar SERVER_FILE_WRONG_SIZE)	"server-file-wrong-size"
BEZ UWIERZYTELNIANIA	"unauthenticated"
BEZ UPRAWNIEŃ	"unauthorized"
UNAUTHORIZED_APP	"unauthorized-app"
BRAK INFORMACJI	"unknown"
NIEOBSŁUGIWANE_ŚRODOWISKO	"unsupported-environment"