storage package

Stockage cloud pour Firebase

Les fonctions

Fonction Description
fonction(application, ...)
getStorage (application, bucketUrl) Obtient une instance FirebaseStorage pour l'application Firebase donnée.
fonction(stockage, ...)
connectStorageEmulator (stockage, hôte, port, options) Modifiez cette instance FirebaseStorage pour communiquer avec l'émulateur Cloud Storage.
ref (stockage, URL) Renvoie une StorageReference pour l’URL donnée.
fonction(réf, ...)
supprimerObjet(réf) Supprime l'objet à cet emplacement.
getBlob (réf, maxDownloadSizeBytes) Télécharge les données à l'emplacement de l'objet. Renvoie une erreur si l'objet n'est pas trouvé. Pour utiliser cette fonctionnalité, vous devez ajouter l'origine de votre application à la liste blanche dans votre bucket Cloud Storage. Voir également https://cloud.google.com/storage/docs/configuring-cors Cette API n'est pas disponible dans Node.
getBytes (réf, maxDownloadSizeBytes) Télécharge les données à l'emplacement de l'objet. Renvoie une erreur si l'objet n'est pas trouvé. Pour utiliser cette fonctionnalité, vous devez ajouter l'origine de votre application à la liste blanche dans votre bucket Cloud Storage. Voir également https://cloud.google.com/storage/docs/configuring-cors
getDownloadURL (réf) Renvoie l'URL de téléchargement pour la StorageReference donnée .
getMetadata(réf) Une Promise qui se résout avec les métadonnées de cet objet. Si cet objet n'existe pas ou si les métadonnées ne peuvent pas être récupérées, la promesse est rejetée.
getStream (réf, maxDownloadSizeBytes) Télécharge les données à l'emplacement de l'objet. Déclenche un événement d'erreur si l'objet n'est pas trouvé. Cette API est uniquement disponible dans Node.
liste (réf, options) Répertoriez les éléments (fichiers) et les préfixes (dossiers) sous cette référence de stockage. L'API de liste n'est disponible que pour la version 2 des règles Firebase. GCS est un magasin de clés blob. Firebase Storage impose la sémantique de la structure de dossiers délimités par « / ». Reportez-vous à l'API List de GCS si vous souhaitez en savoir plus. Pour respecter la sémantique des règles Firebase, Firebase Storage ne prend pas en charge les objets dont les chemins se terminent par "/" ou contiennent deux "/" consécutifs. L'API Firebase Storage List filtrera ces objets non pris en charge. list() peut échouer s'il y a trop d'objets non pris en charge dans le bucket.
listeTout(réf) Répertoriez tous les éléments (fichiers) et préfixes (dossiers) sous cette référence de stockage. Il s'agit d'une méthode d'assistance pour appeler list() à plusieurs reprises jusqu'à ce qu'il n'y ait plus de résultats. La taille de pagination par défaut est de 1 000. Remarque : Les résultats peuvent ne pas être cohérents si les objets sont modifiés pendant l'exécution de cette opération. Attention : listAll peut potentiellement consommer trop de ressources s'il y a trop de résultats.
updateMetadata (réf, métadonnées) Met à jour les métadonnées de cet objet.
uploadBytes (réf, données, métadonnées) Télécharge les données vers l'emplacement de cet objet. Le téléchargement ne peut pas être repris.
uploadBytesResumable (réf, données, métadonnées) Télécharge les données vers l'emplacement de cet objet. Le téléchargement peut être interrompu et repris, et expose les mises à jour de progression.
uploadString(réf, valeur, format, métadonnées) Télécharge une chaîne à l'emplacement de cet objet. Le téléchargement ne peut pas être repris.
fonction (stockageOuRéf, ...)
ref (stockageOuRéf, chemin) Renvoie une StorageReference pour le chemin donné dans le compartiment par défaut.

Des classes

Classe Description
Erreur de stockage Une erreur renvoyée par le SDK Firebase Storage.

Énumérations

Énumération Description
Code d'erreur de stockage Codes d'erreur pouvant être attachés aux objets StorageError .

Interfaces

Interface Description
Stockage Firebase Une instance de stockage Firebase.
Métadonnées complètes L'ensemble complet des métadonnées d'objet, y compris les propriétés en lecture seule.
Options de liste La list() accepte.
ListeRésultat Résultat renvoyé par list().
Métadonnées définissables Métadonnées d'objet pouvant être définies à tout moment.
StockageObservateur Un observateur de flux pour Firebase Storage.
Référence de stockage Représente une référence à un objet Google Cloud Storage. Les développeurs peuvent charger, télécharger et supprimer des objets, ainsi qu'obtenir/définir des métadonnées d'objet.
Télécharger les métadonnées Métadonnées d'objet pouvant être définies lors du téléchargement.
Télécharger le résultat Résultat renvoyé par un téléchargement sans reprise.
Tâche de téléchargement Représente le processus de téléchargement d’un objet. Vous permet de surveiller et de gérer le téléchargement.
TéléchargerTâcheInstantané Contient des données sur l’état actuel de la tâche de téléchargement.

Variables

Variable Description
Format de chaîne Une énumération des formats de chaîne possibles pour le téléchargement.

Tapez les alias

Tapez l'alias Description
Format de chaîne Une énumération des formats de chaîne possibles pour le téléchargement.
Événement de tâche Un événement déclenché sur une tâche.
État de la tâche Représente l’état actuel d’un téléchargement en cours d’exécution.

fonction(application, ...)

getStorage (application, bucketUrl)

Obtient une instance FirebaseStorage pour l'application Firebase donnée.

Signature:

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

Paramètres

Paramètre Taper Description
application FirebaseApp Application Firebase pour laquelle obtenir l'instance FirebaseStorage .
bucketUrl chaîne L'URL gs:// de votre bucket de stockage Firebase. S’il n’est pas transmis, utilise le compartiment de stockage par défaut de l’application.

Retour:

Stockage Firebase

Une instance FirebaseStorage .

fonction(stockage, ...)

connectStorageEmulator (stockage, hôte, port, options)

Modifiez cette instance FirebaseStorage pour communiquer avec l'émulateur Cloud Storage.

Signature:

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

Paramètres

Paramètre Taper Description
stockage Stockage Firebase L'instance FirebaseStorage
hôte chaîne L'hôte de l'émulateur (ex : localhost)
port nombre Le port de l'émulateur (ex : 5001)
choix { mockUserToken ? : EmulatorMockTokenOptions | chaîne; } Options de l'émulateur. options.mockUserToken est le jeton d'authentification fictif à utiliser pour les tests unitaires des règles de sécurité.

Retour:

vide

ref (stockage, URL)

Renvoie une StorageReference pour l’URL donnée.

Signature:

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

Paramètres

Paramètre Taper Description
stockage Stockage Firebase Instance FirebaseStorage .
URL chaîne URL. S'il est vide, renvoie la référence racine.

Retour:

Référence de stockage

fonction(réf, ...)

supprimerObjet(réf)

Supprime l'objet à cet emplacement.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference pour l’objet à supprimer.

Retour:

Promesse<vide>

Une Promise qui se résout si la suppression réussit.

getBlob (réf, maxDownloadSizeBytes)

Télécharge les données à l'emplacement de l'objet. Renvoie une erreur si l'objet n'est pas trouvé.

Pour utiliser cette fonctionnalité, vous devez ajouter l'origine de votre application à la liste blanche dans votre bucket Cloud Storage. Voir également https://cloud.google.com/storage/docs/configuring-cors

Cette API n'est pas disponible dans Node.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference où les données doivent être téléchargées.
maxDownloadSizeBytes nombre Si définie, la taille maximale autorisée en octets à récupérer.

Retour:

Promesse<Blob>

Une promesse qui se résout avec un Blob contenant les octets de l'objet

getBytes (réf, maxDownloadSizeBytes)

Télécharge les données à l'emplacement de l'objet. Renvoie une erreur si l'objet n'est pas trouvé.

Pour utiliser cette fonctionnalité, vous devez ajouter l'origine de votre application à la liste blanche dans votre bucket Cloud Storage. Voir également https://cloud.google.com/storage/docs/configuring-cors

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference où les données doivent être téléchargées.
maxDownloadSizeBytes nombre Si définie, la taille maximale autorisée en octets à récupérer.

Retour:

Promesse<ArrayBuffer>

Une promesse contenant les octets de l'objet

getDownloadURL (réf)

Renvoie l'URL de téléchargement pour la StorageReference donnée .

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference pour lequel obtenir l’URL de téléchargement.

Retour:

Promesse<string>

Une Promise qui se résout avec l'URL de téléchargement de cet objet.

getMetadata(réf)

Une Promise qui se résout avec les métadonnées de cet objet. Si cet objet n'existe pas ou si les métadonnées ne peuvent pas être récupérées, la promesse est rejetée.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference à partir duquel obtenir les métadonnées.

Retour:

Promesse < FullMetadata >

getStream (réf, maxDownloadSizeBytes)

Télécharge les données à l'emplacement de l'objet. Déclenche un événement d'erreur si l'objet n'est pas trouvé.

Cette API est uniquement disponible dans Node.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference où les données doivent être téléchargées.
maxDownloadSizeBytes nombre Si définie, la taille maximale autorisée en octets à récupérer.

Retour:

NodeJS.ReadableStream

Un flux avec les données de l'objet sous forme d'octets

liste (réf, options)

Répertoriez les éléments (fichiers) et les préfixes (dossiers) sous cette référence de stockage.

L'API de liste n'est disponible que pour la version 2 des règles Firebase.

GCS est un magasin de clés blob. Firebase Storage impose la sémantique de la structure de dossiers délimités par « / ». Reportez-vous à l'API List de GCS si vous souhaitez en savoir plus.

Pour respecter la sémantique des règles Firebase, Firebase Storage ne prend pas en charge les objets dont les chemins se terminent par "/" ou contiennent deux "/" consécutifs. L'API Firebase Storage List filtrera ces objets non pris en charge. list() peut échouer s'il y a trop d'objets non pris en charge dans le compartiment.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference à partir duquel obtenir la liste.
choix Options de liste Voir ListOptions pour plus de détails.

Retour:

Promesse < ListResult >

Une Promise qui se résout avec les éléments et les préfixes. prefixes contiennent des références aux sous-dossiers et items contiennent des références aux objets de ce dossier. nextPageToken peut être utilisé pour obtenir le reste des résultats.

listeTout(réf)

Répertoriez tous les éléments (fichiers) et préfixes (dossiers) sous cette référence de stockage.

Il s'agit d'une méthode d'assistance pour appeler list() à plusieurs reprises jusqu'à ce qu'il n'y ait plus de résultats. La taille de pagination par défaut est de 1 000.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference à partir duquel obtenir la liste.

Retour:

Promesse < ListResult >

Une Promise qui se résout avec tous les éléments et préfixes sous la référence de stockage actuelle. prefixes contiennent des références aux sous-répertoires et items contiennent des références aux objets de ce dossier. nextPageToken n'est jamais renvoyé.

updateMetadata (réf, métadonnées)

Met à jour les métadonnées de cet objet.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference pour lequel mettre à jour les métadonnées.
métadonnées Métadonnées définissables Les nouvelles métadonnées de l'objet. Seules les valeurs explicitement définies seront modifiées. Définir explicitement une valeur sur null supprimera les métadonnées.

Retour:

Promesse < FullMetadata >

Une Promise qui se résout avec les nouvelles métadonnées de cet objet.

uploadBytes (réf, données, métadonnées)

Télécharge les données vers l'emplacement de cet objet. Le téléchargement ne peut pas être repris.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference où les données doivent être téléchargées.
données Goutte | Uint8Array | TableauBuffer Les données à télécharger.
métadonnées Télécharger les métadonnées Métadonnées pour les données à télécharger.

Retour:

Promesse< UploadResult >

Une promesse contenant un UploadResult

uploadBytesResumable (réf, données, métadonnées)

Télécharge les données vers l'emplacement de cet objet. Le téléchargement peut être interrompu et repris, et expose les mises à jour de progression.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference où les données doivent être téléchargées.
données Goutte | Uint8Array | TableauBuffer Les données à télécharger.
métadonnées Télécharger les métadonnées Métadonnées pour les données à télécharger.

Retour:

Tâche de téléchargement

Une tâche de téléchargement

uploadString(réf, valeur, format, métadonnées)

Télécharge une chaîne à l'emplacement de cet objet. Le téléchargement ne peut pas être repris.

Signature:

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

Paramètres

Paramètre Taper Description
réf Référence de stockage StorageReference où la chaîne doit être téléchargée.
valeur chaîne La chaîne à télécharger.
format Format de chaîne Le format de la chaîne à télécharger.
métadonnées Télécharger les métadonnées Métadonnées de la chaîne à télécharger.

Retour:

Promesse< UploadResult >

Une promesse contenant un UploadResult

fonction (stockageOuRéf, ...)

ref (stockageOuRéf, chemin)

Renvoie une StorageReference pour le chemin donné dans le compartiment par défaut.

Signature:

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

Paramètres

Paramètre Taper Description
stockageOuRéf Stockage Firebase | Référence de stockage FirebaseStorage ou StorageReference .
chemin chaîne

Retour:

Référence de stockage

Format de chaîne

Une énumération des formats de chaîne possibles pour le téléchargement.

Signature:

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

Format de chaîne

Une énumération des formats de chaîne possibles pour le téléchargement.

Signature:

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

Événement de tâche

Un événement déclenché sur une tâche.

Signature:

export declare type TaskEvent = 'state_changed';

État de la tâche

Représente l’état actuel d’un téléchargement en cours d’exécution.

Signature:

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

Code d'erreur de stockage

Codes d'erreur pouvant être attachés aux objets StorageError .

Signature:

export declare enum StorageErrorCode

Membres de l'énumération

Membre Valeur Description
APP_DELETED "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
ANNULÉ "canceled"
CANNOT_SLICE_BLOB "cannot-slice-blob"
ERREUR INTERNE "internal-error"
ARGUMENT INVALIDE "invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
INVALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
FORMAT INVALIDE "invalid-format"
INVALID_ROOT_OPERATION "invalid-root-operation"
URL INVALIDE "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
OBJET NON TROUVÉ "object-not-found"
PROJECT_NOT_FOUND "project-not-found"
QUOTA DÉPASSÉ "quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
NON AUTHENTIFIÉ "unauthenticated"
NON AUTORISÉ "unauthorized"
UNAUTHORIZED_APP "unauthorized-app"
INCONNU "unknown"
UNSUPPORTED_ENVIRONMENT "unsupported-environment"