@unikvs/s3.bun

S3 互換のオブジェクトストレージにバイト列を保存する @unikvs/s3.bun の使い方を説明します。

概要

@unikvs/s3.bun は S3 互換のオブジェクトストレージにバイト列を保存するストレージプラグインです。Bun 専用クラウドや S3 互換ストレージへの永続化に使います。

name は "S3" で、isOpen で開閉状態を確認します。
open() でクライアントを作成し、close() で参照を外します。
このストレージは、コンストラクターで指定したバケットに対してすべての操作を行い、キーをオブジェクトキーとしてそのまま使います。

インストールは次のコマンドで行います。

npm install @unikvs/s3.bun

pnpm add @unikvs/s3.bun

yarn add @unikvs/s3.bun

bun add @unikvs/s3.bun

nub add @unikvs/s3.bun

aube add @unikvs/s3.bun

別途 S3 互換のオブジェクトストレージが必要です。

使い方

S3 は IStorage を実装しています。UniKvs には persist() で渡します。

import { S3 } from "@unikvs/s3.bun";

S3

S3 互換ストレージに保存するストレージです。利用者は open() で開き、使い終わったら close() で閉じます。

コンストラクターの引数は次のとおりです。

プロパティ型

bucketstring

データを保存するバケット名です。

型string

options?S3StorageOptions

Bun の `S3Client` に渡す設定です。エンドポイントや認証情報などを指定します。

型S3StorageOptions

S3StorageOptions

Bun の S3Options から bucket を除いた設定型です。バケット名はコンストラクターの第 1 引数で指定します。

以下は、値を保存して読み戻す例です。

import { S3 } from "@unikvs/s3.bun";
import * as unikvs from "unikvs";

const kvs = new unikvs.Builder<{ file: unikvs.Value<Uint8Array> }>()
  .persist(new S3("my-bucket"))
  .build();

await kvs.open();

await kvs.set("file", new Uint8Array([0, 1, 2]));

const data = await kvs.get("file");
console.log(data); // Uint8Array(3) [0, 1, 2]

await kvs.close();

データ型

操作	対応するデータ型
`write`・`read`	`Uint8Array<ArrayBuffer>`
`getWritable`・`getReadable` のチャンク	`Uint8Array<ArrayBuffer>`

write・read にはバイト列 (Uint8Array<ArrayBuffer>) を使います。
ストリームの読み書きに対応し、チャンクは Uint8Array<ArrayBuffer> です。
書き込みストリームのパートサイズは実行時変数の @unikvs/s3.bun:partSize (なければ @unikvs/s3:partSize) で変えられます。
clear() はバケット内のオブジェクトを列挙してすべて削除します。