@unikvs/s3.bun

How to use @unikvs/s3.bun, which stores byte sequences in S3-compatible object storage.

Overview

@unikvs/s3.bun is a storage plugin that stores byte sequences in S3-compatible object storage. Bun only Use it for persistence in the cloud or in S3-compatible storage.

name is "S3", and isOpen reports whether it is open.
open() creates the client, and close() releases the reference.
This storage performs all operations against the bucket given in the constructor, using keys as-is as object keys.

Install it with the following command:

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-compatible object storage is required separately.

Usage

S3 implements IStorage. Pass it to UniKvs via persist().

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

S3

Storage that saves to S3-compatible storage. Callers open it with open() and close it with close() when done.

The constructor arguments are as follows:

PropType

bucketstring

The bucket name to store data in.

Typestring

options?S3StorageOptions

Settings passed to the Bun `S3Client`, such as the endpoint and credentials.

TypeS3StorageOptions

S3StorageOptions

Bun S3Options minus bucket. Specify the bucket name as the first constructor argument.

The following example saves a value and reads it back:

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();

Data types

Operation	Data type
`write` / `read`	`Uint8Array<ArrayBuffer>`
`getWritable` / `getReadable` chunks	`Uint8Array<ArrayBuffer>`

write / read use byte sequences (Uint8Array<ArrayBuffer>).
Supports streamed reading and writing with Uint8Array<ArrayBuffer> chunks.
The write-stream part size can be changed with the runtime variable @unikvs/s3.bun:partSize (or @unikvs/s3:partSize).
clear() lists and deletes every object in the bucket.