A simple, lightweight s3 client. Only 2 dependencies total.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
AJ ONeal c95f188d61 1.1.1 4 years ago
bin v1.0.3: add bin 4 years ago
.gitignore v1.0.2: improve docs and error messages 4 years ago
.jshintrc v1.0.0: a diet s3 client 4 years ago
.prettierrc v1.0.0: a diet s3 client 4 years ago
LICENSE v1.0.0: a diet s3 client 4 years ago
README.md add ability to sign() without fetch 4 years ago
index.js bugfix using manual host (minio) for bucket 4 years ago
package-lock.json 1.1.1 4 years ago
package.json 1.1.1 4 years ago
test.bin v1.0.0: a diet s3 client 4 years ago
test.js v1.0.2: improve docs and error messages 4 years ago

README.md

s3.js | a Root project

Minimalist S3 client

A lightweight alternative to the s3 SDK that uses only @root/request and aws4.

  • set()
  • get()
  • head()
  • delete()
  • sign()

Download a file from S3

s3.get({
    accessKeyId,
    secretAccessKey,
    region,
    bucket,
    prefix,
    key
});

Upload a new file to S3

s3.set({
    accessKeyId,
    secretAccessKey,
    region,
    bucket,
    prefix,
    key,
    body,
    size
});

Return signed URL without fetching.

s3.sign({
    method: 'get',
    accessKeyId,
    secretAccessKey,
    region,
    bucket,
    prefix,
    key
});

If the body is a stream then size must be set to fs.statSync(filePath).size, or the request will fail:

501
<Code>NotImplemented</Code><Message>A header you provided implies functionality that is not implemented</Message>