Object Storage Typescript SDK

Overview

The @replit/object-storage package offers a TypeScript client library to interact with Object Storage. It provides a quick and efficient way to integrate Object Storage into Node.js applications. While it's feasible to utilize Object Storage via the Google Node.js Client for Cloud Storage or the Google Cloud Storage JSON API, the Replit client library streamlines application development with Object Storage by eliminating the need for custom authentication logic and Bucket configuration.

note

This package is intended for server-side applications only. It leverages Node.js features and native filesystem functionalities, making it incompatible with browser environments.

Installation

The Object Storage Typescript SDK is available via the @replit/object-storage package in NPM.

You can install the Object Storage package by using one of the following methods:

One-click Setup

Navigate to your Workspace, select + to add a new tab, and search for Object Storage. In the Object Storage pane, use the one-click setup Install @replit/object-storage package button to install the package.

Using npm

You can install the package via the shell using npm:

npm install @replit/object-storage

Using yarn

yarn add @replit/object-storage

The library is compatible with Bun, Deno, and NodeJS (Node version 14+).

Quick Start

Follow this guide to set up the Object Storage TypeScript SDK and perform basic operations like adding, retrieving, listing, and deleting Objects in your Bucket.

Setup a Client

Create a new client instance without any parameters:

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

Add an Object

Upload an Object by providing its name and contents:

const { ok, error } = await client.uploadFromText('file.txt', "Hello World!")
if (!ok) {
    // ... handle the error ...
}

Get an Object

Retrieve an Object's contents as text:

const { ok, value, error } = await client.downloadAsText('file.txt');
if (!ok) {
    // ... handle the error ...
}
console.log(contents);
// > "Hello World!"

List the Objects in the Bucket

List all Objects within the Bucket:

const { ok, value, error } = await client.list();
if (!ok) {
    // ... handle the error ...
}
console.log(contents);
// > [{ name: 'file.txt' }]

Delete an Object

Delete an Object from the Bucket:

const { ok, error } = await client.delete("file.txt");
if (!ok) {
    // ... handle the error ...
}