Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@s3bubble/aws-directory-upload

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@s3bubble/aws-directory-upload

Uploaded a folder and subfolders to AWS S3 bucket with progress events AWS SDK V3

  • 1.1.5
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

AWS Directory Upload

npm install @s3bubble/aws-directory-upload
const awsDirectoryUpload = require("@s3bubble/aws-directory-upload");

let uploader = new awsDirectoryUpload({
    localFolderPath: "/Users/dave/Desktop/folder", // Required - The path to the folder you want to upload
    s3UploadBucket: "bucket", // Required - The name of the S3 bucket you want to upload to
    s3UploadFolder: "folder", // Required - The folder you would like to create in your bucket for the upload
    //chunkSize: 10, // Optional - the amount of files to upload at one time
    //removeUploadedFiles: true, // Optional - if set to true this will remove the files after they have been uploaded
    //filterExtensions: ['mp3'],  // Optional - only upload certain file types
    //accessKeyId: '', // Optional - Your AWS IAM access id
    //secretAccessKey: '' // Optional - Your AWS IAM secret access key
});

uploader.on("progress", function (data) {
    console.log(data);
});

uploader.on("finished", function (data) {
    console.log("finished", data);
});

uploader.on("details", function (data) {
    console.log("details", data);
});

uploader.on("files", function (files) {
    console.log(files);
});

uploader.on("error", function (err) {
    console.log(err);
});

API

Available Params

ParamsDescription
localFolderPathThe path to the folder on your computer you want to upload
s3UploadBucketThe AWS S3 bucket name you want to upload to
s3UploadFolderThe AWS S3 folder name you want to upload to
chunkSizeThe size to split the files into manageable chunks to upload
removeUploadedFilesIf set when a batch of files have been uploaded they will be delete locally
filterExtensionsOnly upload files with specific extensions accepts array ['mp3','mp4']
accessKeyIdYour AWS IAM access id
secretAccessKeyYour AWS IAM secret access key

Available Events

EventsDescription
progressLists progress, totalProgress, chunkedIndex, chunkedLength
finishedWhen all files have been uploaded
filesReturns the batch of uploaded files
errorLists any errors

Things to add

  • Set ACL's to public or private
  • Check if file exists first before uploading
  • Add retrys

Keywords

FAQs

Package last updated on 19 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc