s3-simple v0.0.13

s3-simple

Overview

Download, upload, and check for existence in S3 and S3-compatible stores without needing a huge package.

Usage

import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
const { accessKeyId, secretAccessKey, sessionToken } =
  await fromNodeProviderChain()();

const s3 = new S3Client({
  accessKeyId,
  secretAccessKey,
  sessionToken,
});

await s3.put('bucket', '/asd/asd/zzzz asd zzz.js', {
    content: 'pasosadisod',
    contentType: 'jpeg',
  },
  {
    'x-amz-acl': 'public-read',
  }),
);

await s3.get('bucket', '/asd/asd/zzzz asd zzz.js');
await s3.head('bucket', '/asd/asd/zzzz asd zzz.js');
await s3.delete('bucket', '/asd/asd/zzzz asd zzz.js');
await s3.get('bucket', '/asd/asd/zzzz asd zzz.js'); // Will error because it was deleted

Pass in credentials however you like. You might be able to get the ENV vars and pass those in or you might need to use fromNodeProviderChain like in this example.

Building

Wil output to a top-level dist folder.

npm install
npm run build

Testing

Requires Node 23 for --experimental-strip-types --experimental-test-coverage that are used for running tests and generating coverage.

npm install
npm run test
# Or for coverage
npm run coverage

There are also a recommended VSCode extensions that will help run tests and show coverage in the editor.