Minima.js

Appearance

Minima.js API

Minima.js API / @minimajs/aws-s3 / createS3Driver

Function: createS3Driver() ​

Call Signature ​

ts
function createS3Driver(options): DiskDriver;

Create an S3 storage driver for @minimajs/disk

Use web-native File APIs to interact with AWS S3—no need to learn the AWS SDK.

Parameters ​

options ​

S3DriverOptions

Returns ​

DiskDriver

Example ​

typescript
import { createS3Driver } from '@minimajs/aws-s3';
import { createDisk } from '@minimajs/disk';

const s3Driver = createS3Driver({
  bucket: 'my-bucket',
  region: 'us-east-1',
  credentials: {
    accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
  },
  publicUrl: 'https://d1234.cloudfront.net', // optional CloudFront URL
});

const disk = createDisk({ driver: s3Driver });

// Use web-native APIs - no AWS SDK needed!
await disk.put('uploads/photo.jpg', imageBuffer);
const file = await disk.get('uploads/photo.jpg');
const blob = await file.blob(); // Standard File API

Call Signature ​

ts
function createS3Driver(client, options): DiskDriver;

Create an S3 storage driver for @minimajs/disk

Use web-native File APIs to interact with AWS S3—no need to learn the AWS SDK.

Parameters ​

client ​

S3Client

options ​

S3BaseDriverOptions

Returns ​

DiskDriver

Example ​

typescript
import { createS3Driver } from '@minimajs/aws-s3';
import { createDisk } from '@minimajs/disk';

const s3Driver = createS3Driver({
  bucket: 'my-bucket',
  region: 'us-east-1',
  credentials: {
    accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
  },
  publicUrl: 'https://d1234.cloudfront.net', // optional CloudFront URL
});

const disk = createDisk({ driver: s3Driver });

// Use web-native APIs - no AWS SDK needed!
await disk.put('uploads/photo.jpg', imageBuffer);
const file = await disk.get('uploads/photo.jpg');
const blob = await file.blob(); // Standard File API