npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

s3-forklift

v1.1.0

Published

aws-sdk based kinda simple s3 uploader

Downloads

153

Readme

s3-forklift

aws-sdk based kinda high level s3 / spaces (Digital Ocean) uploader. It wraps upload method of aws-sdk. For file upload, ContentType automatically added. Also, it can remove uploaded file from the file system, after upload completed successfully.

Install

npm install s3-forklift --save

Test

Rename secret.example.json to secret.json with valid credentials.

Then, run test via npm run test

Requirements

  • Node.js 10+

Initialize

const Forklift = require("s3-forklift");

// Initialize;
const forklift = new Forklift({
  cloud: "<CLOUD_NAME>", // do or aws
  accessKey: "<YOUR_ACCESS_KEY>",
  secretKey: "<YOUR_SECRET_KEY>",
  bucket: "<BUCKET_NAME>",
  region: "<REGION>", // optional, default: "us-east-1"
  s3params: {ACL: "bucket-owner-read"} // optional, default: {ACL: "public-read"}
});

Upload

  • source should be string (file path) or readable stream.
  • remotePath s3 path.
  • options Besides the all the options of original S3.upload you can pass
    • {remove: true} to remove the source after upload completed successfully
    • {timestamp: true} to add timestamp at the end of url
const url = await forklift.upload({source, remotePath, options});

Example

// To upload file
// ContentType automatically retrieved from file name and passed to S3.upload method
// if you want to override it, you should pass {ContentType:"<CONTENT_TYPE>"} as options.
const url = await forklift.upload({
	source: "test.jpg", 
	remotePath: "test/test.jpg"
});

// To upload and then remove the file with callback
const url = await forklift.upload({
	source: "test.jpg", 
	remotePath: "test/test.jpg",
	options: {remove: true}
});

// To upload a stream without ContentType
const url = await forklift.upload({
	source: fs.createReadStream("test.jpg"), 
	remotePath: "test/test.jpg"
});

// To upload a stream with ContentType
const url = await forklift.upload({
	source: fs.createReadStream("test.jpg"), 
	remotePath: "test/test.jpg",
	options: {ContentType:"image/jpeg"}
});