This guide demonstrates how to use the JavaScript client library to upload, list, download, and delete objects in your Object Storage bucket.

This client library, written in TypeScript, can be used for projects that use JavaScript runtimes such as Bun, Deno, and Node.js 14 and later.

​
Create a TypeScript Replit App

  1. Select plus sign Create App from the home screen.
  2. Navigate to the Choose a Template tab.
  3. Type “TypeScript” in the template search field and select it as shown below:
  4. Select plus sign Create App.

​
Install the official client library

To install the client library, follow the one-click setup or package manager instructions below.

1

Access the Object Storage tool

  1. Navigate to the Object Storage tab.
  2. Select the angled brackets icon Commands view in the Object Storage tab.

The installation screen should resemble the following screenshot:

2

Install the dependencies

  1. Select “JavaScript” from the programming language dropdown on the top left.
  2. Select Install @replit/object-storage package.
  3. When completed, the button text should read Package installed.

​
Create a bucket

Before storing objects, you must create a bucket. Follow the steps below to create a new bucket:

  1. Navigate to the Object Storage tool
  2. Select Create new bucket
  3. Enter a name for the bucket in the Name field
  4. Select Create bucket

​
Add and run the example code

1

Locate index.ts

Open the files icon Files tool from the left dock.

Select index.ts to open it in a file editor.

2

Add the client code

Replace the contents of index.ts with the following code:

import { Client } from "@replit/object-storage";
const client = new Client();

// Upload a text file that contains the text "Hello, World!"
const { ok: uploadOk, error: uploadError } = await client.uploadFromText(
  "file.txt",
  "Hello World!",
);
if (!uploadOk) console.error("Upload failed:", uploadError);

// List the objects in the bucket
const { ok: listOk, value: listValue, error: listError } = await client.list();
if (!listOk) console.error("List failed:", listError);
else console.log("Bucket contents:", listValue);

// Retrieve and print the contents of the uploaded file
const {
  ok: downloadOk,
  value,
  error: downloadError,
} = await client.downloadAsText("file.txt");
if (!downloadOk) console.error("Download failed:", downloadError);
else console.log("file.txt contents:", value);
3

Run the app

Select Run to execute the example code.

Navigate to the Console tab to view the output, which should resemble the output below:

Bucket contents: [ { name: 'file.txt' } ]
file.txt contents: Hello World!

Confirm that the file.txt object appears in your bucket in the Objects view of the Object Storage tool.

Reload the page to update the object list if file.txt fails to appear.

​
Delete the object

To remove the file.txt file from the bucket,

  1. Replace the content of index.ts with the following code:

    import { Client } from "@replit/object-storage";
const client = new Client();

// Delete file.txt from the bucket
const { ok: deleteOk, error: deleteError } = await client.delete("file.txt");
if (!deleteOk) console.error("Delete failed:", deleteError);
else console.log("Delete succeeded");

  2. Select Run to execute the example code.

  3. Navigate to the Console tab to view the output, which should resemble the output below:

    Delete succeeded

  4. Verify that the file.txt object no longer appears in the bucket.

​
Next steps

To learn more about Replit Object Storage, see the following resources:

Was this page helpful?