Skip to content

Minima.js API


Minima.js API / @minimajs/aws-s3

@minimajs/aws-s3

AWS S3 storage driver for @minimajs/disk.

Interact with S3 using web-native File APIs — no need to learn the AWS SDK. Supports plain paths, s3://bucket/key URIs, and public CDN URLs as file references.

Example

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

const disk = createDisk({
  driver: 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 CDN
  }),
});

await disk.put('uploads/photo.jpg', imageBuffer);
const file = await disk.get('uploads/photo.jpg');
const blob = await file.blob();

Classes

ClassDescription
S3DriverAWS S3 storage driver for @minimajs/disk

Interfaces

InterfaceDescription
S3BaseDriverOptions-

Functions

FunctionDescription
createS3DriverCreate an S3 storage driver for @minimajs/disk