storage package

Cloud-Speicher für Firebase

Funktionen

Funktion Beschreibung
Funktion(App, ...)
getStorage(app, BucketUrl) Ruft eine FirebaseStorage- Instanz für die angegebene Firebase-App ab.
Funktion (Speicher, ...)
connectStorageEmulator(Speicher, Host, Port, Optionen) Ändern Sie diese FirebaseStorage- Instanz, um mit dem Cloud Storage-Emulator zu kommunizieren.
ref(Speicher, URL) Gibt eine StorageReference für die angegebene URL zurück.
Funktion(ref, ...)
deleteObject(ref) Löscht das Objekt an dieser Stelle.
getBlob(ref, maxDownloadSizeBytes) Lädt die Daten am Speicherort des Objekts herunter. Gibt einen Fehler zurück, wenn das Objekt nicht gefunden wird. Um diese Funktionalität nutzen zu können, müssen Sie den Ursprung Ihrer App in Ihrem Cloud Storage-Bucket auf die Whitelist setzen. Siehe auch https://cloud.google.com/storage/docs/configuring-cors Diese API ist in Node nicht verfügbar.
getBytes(ref, maxDownloadSizeBytes) Lädt die Daten am Speicherort des Objekts herunter. Gibt einen Fehler zurück, wenn das Objekt nicht gefunden wird. Um diese Funktionalität nutzen zu können, müssen Sie den Ursprung Ihrer App in Ihrem Cloud Storage-Bucket auf die Whitelist setzen. Siehe auch https://cloud.google.com/storage/docs/configuring-cors
getDownloadURL(ref) Gibt die Download-URL für die angegebene StorageReference zurück .
getMetadata(ref) Ein Promise , das mit den Metadaten für dieses Objekt aufgelöst wird. Wenn dieses Objekt nicht existiert oder Metadaten nicht abgerufen werden können, wird das Versprechen abgelehnt.
getStream(ref, maxDownloadSizeBytes) Lädt die Daten am Speicherort des Objekts herunter. Löst ein Fehlerereignis aus, wenn das Objekt nicht gefunden wird. Diese API ist nur in Node verfügbar.
list(ref, Optionen) Listen Sie Elemente (Dateien) und Präfixe (Ordner) unter dieser Speicherreferenz auf. Die Listen-API ist nur für Firebase Rules Version 2 verfügbar. GCS ist ein Schlüssel-Blob-Speicher. Firebase Storage schreibt die Semantik einer durch „/“ getrennten Ordnerstruktur vor. Weitere Informationen finden Sie in der Listen-API von GCS. Um die Semantik der Firebase-Regeln einzuhalten, unterstützt Firebase Storage keine Objekte, deren Pfade mit „/“ enden oder zwei aufeinanderfolgende „/“ enthalten. Die Firebase Storage List API filtert diese nicht unterstützten Objekte. list() schlägt möglicherweise fehl, wenn sich zu viele nicht unterstützte Objekte im Bucket befinden.
listAll(ref) Listen Sie alle Elemente (Dateien) und Präfixe (Ordner) unter dieser Speicherreferenz auf. Dies ist eine Hilfsmethode zum wiederholten Aufrufen von list(), bis keine Ergebnisse mehr vorliegen. Die Standard-Paginierungsgröße beträgt 1000. Hinweis: Die Ergebnisse sind möglicherweise nicht konsistent, wenn Objekte während der Ausführung dieses Vorgangs geändert werden. Warnung: listAll verbraucht möglicherweise zu viele Ressourcen, wenn zu viele Ergebnisse vorliegen.
updateMetadata(ref, metadata) Aktualisiert die Metadaten für dieses Objekt.
uploadBytes(ref, data, metadata) Lädt Daten an den Standort dieses Objekts hoch. Der Upload kann nicht fortgesetzt werden.
uploadBytesResumable(ref, data, metadata) Lädt Daten an den Standort dieses Objekts hoch. Der Upload kann angehalten und fortgesetzt werden und zeigt Fortschrittsaktualisierungen an.
uploadString(ref, value, format, metadata) Lädt eine Zeichenfolge an den Speicherort dieses Objekts hoch. Der Upload kann nicht fortgesetzt werden.
Funktion(storageOrRef, ...)
ref(storageOrRef, Pfad) Gibt eine StorageReference für den angegebenen Pfad im Standard-Bucket zurück.

Klassen

Klasse Beschreibung
Speicherfehler Ein vom Firebase Storage SDK zurückgegebener Fehler.

Aufzählungen

Aufzählung Beschreibung
StorageErrorCode Fehlercodes, die an StorageError Objekte angehängt werden können.

Schnittstellen

Schnittstelle Beschreibung
FirebaseStorage Eine Firebase Storage-Instanz.
Vollständige Metadaten Der vollständige Satz von Objektmetadaten, einschließlich schreibgeschützter Eigenschaften.
Listenoptionen Die Optionen list() akzeptieren.
Listenergebnis Von list() zurückgegebenes Ergebnis.
SettableMetadata Objektmetadaten, die jederzeit festgelegt werden können.
StorageObserver Ein Stream-Beobachter für Firebase Storage.
Speicherreferenz Stellt einen Verweis auf ein Google Cloud Storage-Objekt dar. Entwickler können Objekte hochladen, herunterladen und löschen sowie Objektmetadaten abrufen/festlegen.
Metadaten hochladen Objektmetadaten, die beim Hochladen festgelegt werden können.
UploadResult Von einem nicht fortsetzbaren Upload zurückgegebenes Ergebnis.
UploadTask Stellt den Prozess des Hochladens eines Objekts dar. Ermöglicht Ihnen, den Upload zu überwachen und zu verwalten.
UploadTaskSnapshot Enthält Daten über den aktuellen Status der Upload-Aufgabe.

Variablen

Variable Beschreibung
StringFormat Eine Aufzählung der möglichen Zeichenfolgenformate für den Upload.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
StringFormat Eine Aufzählung der möglichen Zeichenfolgenformate für den Upload.
TaskEvent Ein Ereignis, das für eine Aufgabe ausgelöst wird.
TaskState Stellt den aktuellen Status eines laufenden Uploads dar.

Funktion(App, ...)

getStorage(app, BucketUrl)

Ruft eine FirebaseStorage- Instanz für die angegebene Firebase-App ab.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App FirebaseApp Firebase-App zum Abrufen der FirebaseStorage- Instanz.
BucketUrl Zeichenfolge Die gs://-URL zu Ihrem Firebase Storage Bucket. Wenn nicht übergeben, wird der Standardspeicher-Bucket der App verwendet.

Kehrt zurück:

FirebaseStorage

Eine FirebaseStorage- Instanz.

Funktion (Speicher, ...)

connectStorageEmulator(Speicher, Host, Port, Optionen)

Ändern Sie diese FirebaseStorage- Instanz, um mit dem Cloud Storage-Emulator zu kommunizieren.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Lagerung FirebaseStorage Die FirebaseStorage- Instanz
Gastgeber Zeichenfolge Der Emulator-Host (z. B. localhost)
Hafen Nummer Der Emulator-Port (z. B. 5001)
Optionen { mockUserToken?: EmulatorMockTokenOptions | Schnur; } Emulatoroptionen. options.mockUserToken ist das Schein-Authentifizierungstoken, das zum Unit-Testen von Sicherheitsregeln verwendet wird.

Kehrt zurück:

Leere

ref(Speicher, URL)

Gibt eine StorageReference für die angegebene URL zurück.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Lagerung FirebaseStorage FirebaseStorage- Instanz.
URL Zeichenfolge URL. Wenn leer, wird die Root-Referenz zurückgegeben.

Kehrt zurück:

Speicherreferenz

Funktion(ref, ...)

deleteObject(ref)

Löscht das Objekt an dieser Stelle.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference für das zu löschende Objekt.

Kehrt zurück:

Versprechen<void>

Ein Promise , das aufgelöst wird, wenn der Löschvorgang erfolgreich ist.

getBlob(ref, maxDownloadSizeBytes)

Lädt die Daten am Speicherort des Objekts herunter. Gibt einen Fehler zurück, wenn das Objekt nicht gefunden wird.

Um diese Funktionalität nutzen zu können, müssen Sie den Ursprung Ihrer App in Ihrem Cloud Storage-Bucket auf die Whitelist setzen. Siehe auch https://cloud.google.com/storage/docs/configuring-cors

Diese API ist in Node nicht verfügbar.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference, wohin Daten heruntergeladen werden sollen.
maxDownloadSizeBytes Nummer Wenn festgelegt, die maximal zulässige Größe in Bytes zum Abrufen.

Kehrt zurück:

Versprochen<Blob>

Ein Versprechen, das mit einem Blob aufgelöst wird, der die Bytes des Objekts enthält

getBytes(ref, maxDownloadSizeBytes)

Lädt die Daten am Speicherort des Objekts herunter. Gibt einen Fehler zurück, wenn das Objekt nicht gefunden wird.

Um diese Funktionalität nutzen zu können, müssen Sie den Ursprung Ihrer App in Ihrem Cloud Storage-Bucket auf die Whitelist setzen. Siehe auch https://cloud.google.com/storage/docs/configuring-cors

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference, wohin Daten heruntergeladen werden sollen.
maxDownloadSizeBytes Nummer Wenn festgelegt, die maximal zulässige Größe in Bytes zum Abrufen.

Kehrt zurück:

Promise<ArrayBuffer>

Ein Promise, das die Bytes des Objekts enthält

getDownloadURL(ref)

Gibt die Download-URL für die angegebene StorageReference zurück .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference , um die Download-URL abzurufen.

Kehrt zurück:

Versprechen<string>

Ein Promise , das mit der Download-URL für dieses Objekt aufgelöst wird.

getMetadata(ref)

Ein Promise , das mit den Metadaten für dieses Objekt aufgelöst wird. Wenn dieses Objekt nicht existiert oder Metadaten nicht abgerufen werden können, wird das Versprechen abgelehnt.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference, von der Metadaten abgerufen werden sollen.

Kehrt zurück:

Versprechen< FullMetadata >

getStream(ref, maxDownloadSizeBytes)

Lädt die Daten am Speicherort des Objekts herunter. Löst ein Fehlerereignis aus, wenn das Objekt nicht gefunden wird.

Diese API ist nur in Node verfügbar.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference, wohin Daten heruntergeladen werden sollen.
maxDownloadSizeBytes Nummer Wenn festgelegt, die maximal zulässige Größe in Bytes zum Abrufen.

Kehrt zurück:

NodeJS.ReadableStream

Ein Stream mit den Daten des Objekts als Bytes

list(ref, Optionen)

Listen Sie Elemente (Dateien) und Präfixe (Ordner) unter dieser Speicherreferenz auf.

Die Listen-API ist nur für Firebase Rules Version 2 verfügbar.

GCS ist ein Schlüssel-Blob-Speicher. Firebase Storage schreibt die Semantik einer durch „/“ getrennten Ordnerstruktur vor. Weitere Informationen finden Sie in der Listen-API von GCS.

Um die Semantik der Firebase-Regeln einzuhalten, unterstützt Firebase Storage keine Objekte, deren Pfade mit „/“ enden oder zwei aufeinanderfolgende „/“ enthalten. Die Firebase Storage List API filtert diese nicht unterstützten Objekte. list() schlägt möglicherweise fehl, wenn sich zu viele nicht unterstützte Objekte im Bucket befinden.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference, von der die Liste abgerufen werden soll.
Optionen Listenoptionen Weitere Informationen finden Sie unter ListOptions .

Kehrt zurück:

Versprechen< ListResult >

Ein Promise , das mit den Elementen und Präfixen aufgelöst wird. prefixes enthalten Verweise auf Unterordner und items enthalten Verweise auf Objekte in diesem Ordner. nextPageToken kann verwendet werden, um die restlichen Ergebnisse abzurufen.

listAll(ref)

Listen Sie alle Elemente (Dateien) und Präfixe (Ordner) unter dieser Speicherreferenz auf.

Dies ist eine Hilfsmethode zum wiederholten Aufrufen von list(), bis keine Ergebnisse mehr vorliegen. Die Standard-Paginierungsgröße beträgt 1000.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference, von der die Liste abgerufen werden soll.

Kehrt zurück:

Versprechen< ListResult >

Ein Promise , das mit allen Elementen und Präfixen unter der aktuellen Speicherreferenz aufgelöst wird. prefixes enthalten Verweise auf Unterverzeichnisse und items enthalten Verweise auf Objekte in diesem Ordner. nextPageToken wird nie zurückgegeben.

updateMetadata(ref, metadata)

Aktualisiert die Metadaten für dieses Objekt.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference , für die Metadaten aktualisiert werden sollen.
Metadaten SettableMetadata Die neuen Metadaten für das Objekt. Es werden nur Werte geändert, die explizit festgelegt wurden. Durch das explizite Festlegen eines Werts auf Null werden die Metadaten entfernt.

Kehrt zurück:

Versprechen< FullMetadata >

Ein Promise , das mit den neuen Metadaten für dieses Objekt aufgelöst wird.

uploadBytes(ref, data, metadata)

Lädt Daten an den Standort dieses Objekts hoch. Der Upload kann nicht fortgesetzt werden.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference , wohin Daten hochgeladen werden sollen.
Daten Klecks | Uint8Array | ArrayBuffer Die hochzuladenden Daten.
Metadaten Metadaten hochladen Metadaten für die hochzuladenden Daten.

Kehrt zurück:

Versprechen< UploadResult >

Ein Versprechen, das ein UploadResult enthält

uploadBytesResumable(ref, data, metadata)

Lädt Daten an den Standort dieses Objekts hoch. Der Upload kann angehalten und fortgesetzt werden und zeigt Fortschrittsaktualisierungen an.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference , wohin Daten hochgeladen werden sollen.
Daten Klecks | Uint8Array | ArrayBuffer Die hochzuladenden Daten.
Metadaten Metadaten hochladen Metadaten für die hochzuladenden Daten.

Kehrt zurück:

UploadTask

Eine UploadTask

uploadString(ref, value, format, metadata)

Lädt eine Zeichenfolge an den Speicherort dieses Objekts hoch. Der Upload kann nicht fortgesetzt werden.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
ref Speicherreferenz StorageReference , wohin die Zeichenfolge hochgeladen werden soll.
Wert Zeichenfolge Die hochzuladende Zeichenfolge.
Format StringFormat Das Format der hochzuladenden Zeichenfolge.
Metadaten Metadaten hochladen Metadaten für die hochzuladende Zeichenfolge.

Kehrt zurück:

Versprechen< UploadResult >

Ein Versprechen, das ein UploadResult enthält

Funktion(storageOrRef, ...)

ref(storageOrRef, Pfad)

Gibt eine StorageReference für den angegebenen Pfad im Standard-Bucket zurück.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
storageOrRef FirebaseStorage | Speicherreferenz FirebaseStorage oder StorageReference .
Weg Zeichenfolge

Kehrt zurück:

Speicherreferenz

StringFormat

Eine Aufzählung der möglichen Zeichenfolgenformate für den Upload.

Unterschrift:

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

StringFormat

Eine Aufzählung der möglichen Zeichenfolgenformate für den Upload.

Unterschrift:

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

TaskEvent

Ein Ereignis, das für eine Aufgabe ausgelöst wird.

Unterschrift:

export declare type TaskEvent = 'state_changed';

TaskState

Stellt den aktuellen Status eines laufenden Uploads dar.

Unterschrift:

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

StorageErrorCode

Fehlercodes, die an StorageError Objekte angehängt werden können.

Unterschrift:

export declare enum StorageErrorCode 

Aufzählungsmitglieder

Mitglied Wert Beschreibung
APP_DELETED "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
ABGESAGT "canceled"
CANNOT_SLICE_BLOB "cannot-slice-blob"
INTERNER FEHLER "internal-error"
UNGÜLTIGES 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"
UNGÜLTIGES FORMAT "invalid-format"
INVALID_ROOT_OPERATION "invalid-root-operation"
UNGÜLTIGE URL "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
OBJEKT NICHT GEFUNDEN "object-not-found"
PROJECT_NOT_FOUND "project-not-found"
QUOTE ÜBERSCHRITTEN "quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
UNAUTHENTIFIZIERT "unauthenticated"
NICHT AUTORISIERT "unauthorized"
UNAUTHORIZED_APP "unauthorized-app"
UNBEKANNT "unknown"
NICHTUNTERSTÜTZTE_UMGEBUNG "unsupported-environment"