Passer au contenu principal
Ce guide de référence explique la classe Client de la bibliothèque object-storage et fournit des exemples de code pour ses méthodes.

​
Client

La classe Client gère les interactions avec le Stockage d’application Replit. Cette classe dispose de méthodes pour effectuer des opérations sur les fichiers dans un compartiment. Pour importer la classe depuis la bibliothèque, ajoutez la ligne suivante à votre code JavaScript : 
import { Client } from "@replit/object-storage";
Utilisez le code suivant pour créer une instance Client qui interagit avec le Stockage d’objets Replit : 
const client = new Client();

​
Constructeurs

constructor
  • new Client(options?) : Client
Crée une nouvelle instance Client pour interagir avec le Stockage d’application Replit. Paramètres
NomTypeDescription
options?ClientOptionsOptions de configuration pour l’initialisation du client.
Retourne Client

​
Méthodes

​
copy

  • copy(objectName, destObjectName) : Promise<Result<null, RequestError>>
Copie un objet dans le même compartiment. Cette méthode écrase tout objet existant au chemin de destination. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à copier.
destObjectNamestringLe chemin complet vers lequel copier l’objet.
Retourne Promise<Result<null, RequestError>>

​
delete

  • delete(objectName, options?) : Promise<Result<null, RequestError>>
Supprime un objet du compartiment. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à supprimer.
options?DeleteOptionsConfigurations pour l’opération de suppression.
Retourne Promise<Result<null, RequestError>>

​
downloadAsBytes

  • downloadAsBytes(objectName, options?) : Promise<Result<Buffer, RequestError>>
Télécharge un objet et retourne son contenu brut sous forme de buffer. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à télécharger.
options?DownloadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<Result<Buffer, RequestError>>

​
downloadAsStream

  • downloadAsStream(objectName, options?) : Readable
Crée un flux lisible du contenu de l’objet. Le flux émet toutes les erreurs rencontrées pendant le téléchargement. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à télécharger.
options?DownloadOptionsConfigurations pour l’opération de téléchargement.
Retourne Readable

​
downloadAsText

  • downloadAsText(objectName, options?) : Promise<Result<string, RequestError>>
Télécharge un objet et retourne son contenu sous forme de chaîne de caractères. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à télécharger.
options?DownloadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<Result<string, RequestError>>

​
downloadToFilename

  • downloadToFilename(objectName, destFilename, options?) : Promise<Result<null, RequestError>>
Télécharge un objet et l’enregistre à l’emplacement spécifié sur le système de fichiers local. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à télécharger.
destFilenamestringLe chemin sur le système de fichiers local où écrire l’objet téléchargé.
options?DownloadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<Result<null, RequestError>>

​
exists

  • exists(objectName) : Promise<Result<boolean, RequestError>>
Vérifie si un objet existe dans le compartiment. Paramètres
NomTypeDescription
objectNamestringLe chemin complet de l’objet à vérifier.
Retourne Promise<Result<boolean, RequestError>>

​
getBucket

  • getBucket() : Promise<Bucket>
Retourne Promise<Bucket>

​
init

  • init(bucketId?) : Promise<Bucket>
Paramètres
NomType
bucketId?string
Retourne Promise<Bucket>

​
list

  • list(options?) : Promise<Result<StorageObject[], RequestError>>
Retourne une liste de tous les objets dans le compartiment. Paramètres
NomTypeDescription
options?ListOptionsConfigurations pour l’opération de listing.
Retourne Promise<Result<StorageObject[], RequestError>>

​
mapUploadOptions

  • mapUploadOptions(options?) : undefined | UploadOptions
Paramètres
NomType
options?UploadOptions
Retourne undefined | UploadOptions

​
uploadFromBytes

  • uploadFromBytes(objectName, contents, options?) : Promise<Result<null, RequestError>>
Télécharge un objet en utilisant sa représentation en octets en mémoire. Cette méthode écrase tout objet existant portant le même nom. Paramètres
NomTypeDescription
objectNamestringLe chemin de destination complet de l’objet.
contentsBufferLe contenu brut de l’objet en forme d’octets.
options?UploadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<Result<null, RequestError>>

​
uploadFromFilename

  • uploadFromFilename(objectName, srcFilename, options?) : Promise<Result<null, RequestError>>
Télécharge un fichier depuis le système de fichiers local vers le compartiment. Cette méthode écrase tout objet existant portant le même nom. Paramètres
NomTypeDescription
objectNamestringLe chemin de destination complet de l’objet.
srcFilenamestringLe chemin du fichier sur le système de fichiers local à télécharger.
options?UploadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<Result<null, RequestError>>

​
uploadFromStream

  • uploadFromStream(objectName, stream, options?) : Promise<void>
Télécharge un objet en lisant son contenu depuis le flux fourni. Le flux émet toutes les erreurs rencontrées pendant le téléchargement. Cette méthode écrase tout objet existant portant le même nom. Paramètres
NomTypeDescription
objectNamestringLe chemin de destination complet de l’objet.
streamReadableUn flux lisible depuis lequel lire le contenu de l’objet.
options?UploadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<void>

​
uploadFromText

  • uploadFromText(objectName, contents, options?) : Promise<Result<null, RequestError>>
Télécharge un objet en utilisant sa représentation textuelle en mémoire. Cette méthode écrase tout objet existant portant le même nom. Paramètres
NomTypeDescription
objectNamestringLe chemin de destination complet de l’objet.
contentsstringLe contenu de l’objet sous forme de texte.
options?UploadOptionsConfigurations pour l’opération de téléchargement.
Retourne Promise<Result<null, RequestError>>

​
Exemples de méthodes

Les sections suivantes fournissent des exemples de code pour gérer vos fichiers à l’aide du SDK du Stockage d’objets Replit.

​
Récupérer un objet en tant que texte

const { ok, value: textValue, error } = await client.downloadAsText('file.json');
if (!ok) {
    // ... gérer l'erreur ...
}

​
Récupérer un objet sous forme d’octets bruts

const { ok, value: bytesValue, error } = await client.downloadAsBytes('file.png');
if (!ok) {
    // ... gérer l'erreur ...
}

​
Récupérer un objet depuis un flux

const { ok, value: stream, error } = await client.downloadAsStream('file.json');
if (!ok) {
    // ... gérer l'erreur ...
}

​
Télécharger un objet sur le système de fichiers

const { ok, error } = await client.downloadToFilename('file.json', destFilename);
if (!ok) {
    // ... gérer l'erreur ...
}

​
Lister les objets dans le compartiment

const { ok, value, error } = await client.list();
if (!ok) {
    // ... gérer l'erreur ...
}

​
Télécharger un objet depuis du texte

const { ok, error } = await client.uploadFromText('file.json', data);
if (!ok) {
    // ... gérer l'erreur ...
}

​
Télécharger un objet en octets

const { ok, error } = await client.uploadFromBytes('file.png', data);
if (!ok) {
    // ... gérer l'erreur ...
}

​
Télécharger un objet depuis le système de fichiers

const { ok, error } = await client.uploadFromFilename('file.json', srcFilename);
if (!ok) {
    // ... gérer l'erreur ...
}

​
Télécharger un objet depuis un flux

const { ok, error } = await client.uploadFromStream('file.json', stream);
if (!ok) {
    // ... gérer l'erreur ...
}

​
Supprimer un objet du compartiment

const { ok, error } = await client.delete('file.json');
if (!ok) {
    // ... gérer l'erreur ...
}