App Storage JavaScript SDK

​

Client

import { Client } from "@replit/object-storage";

const client = new Client();

​

コンストラクタ

• new Client(options?): Client

​

メソッド

​

copy

• copy(objectName, destObjectName): Promise<Result<null, RequestError>>

​

delete

• delete(objectName, options?): Promise<Result<null, RequestError>>

​

downloadAsBytes

• downloadAsBytes(objectName, options?): Promise<Result<Buffer, RequestError>>

​

downloadAsStream

• downloadAsStream(objectName, options?): Readable

​

downloadAsText

• downloadAsText(objectName, options?): Promise<Result<string, RequestError>>

​

downloadToFilename

• downloadToFilename(objectName, destFilename, options?): Promise<Result<null, RequestError>>

​

exists

• exists(objectName): Promise<Result<boolean, RequestError>>

​

getBucket

• getBucket(): Promise<Bucket>

​

init

• init(bucketId?): Promise<Bucket>

​

list

• list(options?): Promise<Result<StorageObject[], RequestError>>

​

mapUploadOptions

• mapUploadOptions(options?): undefined | UploadOptions

​

uploadFromBytes

• uploadFromBytes(objectName, contents, options?): Promise<Result<null, RequestError>>

​

uploadFromFilename

• uploadFromFilename(objectName, srcFilename, options?): Promise<Result<null, RequestError>>

​

uploadFromStream

• uploadFromStream(objectName, stream, options?): Promise<void>

​

uploadFromText

• uploadFromText(objectName, contents, options?): Promise<Result<null, RequestError>>

​

メソッドの例

​

オブジェクトをテキストとして取得する

const { ok, value: textValue, error } = await client.downloadAsText('file.json');
if (!ok) {
    // ... handle error ...
}

​

オブジェクトを生バイト表現として取得する

const { ok, value: bytesValue, error } = await client.downloadAsBytes('file.png');
if (!ok) {
    // ... handle error ...
}

​

ストリームからオブジェクトを取得する

const { ok, value: stream, error } = await client.downloadAsStream('file.json');
if (!ok) {
    // ... handle error ...
}

​

オブジェクトをファイルシステムにダウンロードする

const { ok, error } = await client.downloadToFilename('file.json', destFilename);
if (!ok) {
    // ... handle error ...
}

​

バケット内のオブジェクトを一覧表示する

const { ok, value, error } = await client.list();
if (!ok) {
    // ... handle error ...
}

​

テキストからオブジェクトをアップロードする

const { ok, error } = await client.uploadFromText('file.json', data);
if (!ok) {
    // ... handle error ...
}

​

バイトとしてオブジェクトをアップロードする

const { ok, error } = await client.uploadFromBytes('file.png', data);
if (!ok) {
    // ... handle error ...
}

​

ファイルシステムからオブジェクトをアップロードする

const { ok, error } = await client.uploadFromFilename('file.json', srcFilename);
if (!ok) {
    // ... handle error ...
}

​

ストリームからオブジェクトをアップロードする

const { ok, error } = await client.uploadFromStream('file.json', stream);
if (!ok) {
    // ... handle error ...
}

​

バケットからオブジェクトを削除する

const { ok, error } = await client.delete('file.json');
if (!ok) {
    // ... handle error ...
}