@effect-aws/s3


This package provides the S3 service specific effectful utilities and implementations.

Installation

``bash
npm install --save @effect-aws/s3 @effect-aws/client-s3
`

Usage

$3

The MultipartUpload is a effectful port of the Upload class from the @aws-sdk/lib-storage package.

Example

`ts
import { S3 } from "@effect-aws/client-s3"
import { MultipartUpload } from "@effect-aws/s3"
import { FileSystem } from "@effect/platform"
import { Effect } from "effect"

const program = MultipartUpload.uploadObject(
{
Bucket: "my-bucket",
Key: "my-object",
Body: new Uint8Array(1024 1024 10) // 10 MB
},
{
// (optional) concurrency configuration
queueSize: 4,
// (optional) size of each part, in bytes, at least 5MB
partSize: FileSystem.MiB(5)
}
)

program.pipe(Effect.provide(S3.defaultLayer), Effect.runPromise)
`

$3

The S3FileSystem is an implementation for platform FileSystem tag.
You can use it to operate on files in an S3 bucket as if they were local files.

Example (Reading a File as a String)

`ts
import { S3 } from "@effect-aws/client-s3"
import { S3FileSystem } from "@effect-aws/s3"
import { FileSystem } from "@effect/platform"
import { NodeRuntime } from "@effect/platform-node"
import { Effect } from "effect"

const program = Effect.gen(function* () {
const fs = yield* FileSystem.FileSystem

// Reading the content of the same file where this code is written
const content = yield* fs.readFileString("content.txt")
console.log(content)
})

// Provide the necessary context and run the program
NodeRuntime.runMain(
program.pipe(
// ┌─── Layer
// ▼
Effect.provide(S3FileSystem.layer({ bucketName: "example-bucket" })),
Effect.provide(S3.defaultLayer)
)
)
`

Example (Using Schema Validation in KeyValueStore):

`ts
import { S3 } from "@effect-aws/client-s3"
import { S3FileSystem } from "@effect-aws/s3"
import { Path } from "@effect/platform"
import { KeyValueStore } from "@effect/platform"
import { Effect, Layer, Schema } from "effect"

// Define a schema for the values
const Person = Schema.Struct({
name: Schema.String,
age: Schema.Number
})

const program = Effect.gen(function* () {
// Create a SchemaStore based on the Person schema
const kv = (yield* KeyValueStore.KeyValueStore).forSchema(Person)

// Add a value that adheres to the schema
const value = { name: "Alice", age: 30 }
yield* kv.set("user1", value)
console.log(yield* kv.size)

// Retrieve and log the value
console.log(yield* kv.get("user1"))
})

// Slash is important here, indicating a folder ──────┐
// ▼
const mainLayer = KeyValueStore.layerFileSystem("store/").pipe(
Layer.provide(S3FileSystem.layer({ bucketName: "example-bucket" })),
Layer.provide(S3.defaultLayer),
Layer.provide(Path.layer)
)

// Use the S3 file system store implementation
Effect.runPromise(program.pipe(Effect.provide(mainLayer)))
/*
Output:
1
{ _id: 'Option', _tag: 'Some', value: { name: 'Alice', age: 30 } }
*/
``