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-asset-uploader

v2.4.2

Published

AWS S3 Asset Uploader

Downloads

11

Readme

AWS S3 asset uploader

Greenkeeper badge

Synchronizes a local directory with an Amazon S3 bucket

Options

Key | Type | Description --- | ---- | ----------- path (REQUIRED) | string | the base path to synchronize with S3 ignorePaths | Array.<(RegExp\|string)> | skip these paths when gathering files digestFileKey | AWS.S3.ObjectKey | the destination key of the generated digest file prefix | string | prepended to file names (but not digestFileKey!) when uploaded headers | S3UploadHeaders | extra params used by AWS.S3 upload method gzipHeaders | S3UploadHeaders | extra params used by AWS.S3 upload method for GZIP files gzipHashedFileKeyRegexp | RegExp | gzip the hashed files that match this pattern noUpload | boolean | don't upload anything, just generate a digest mapping noUploadDigestFile | boolean | don't upload the digest mapping file noUploadOriginalFiles | boolean | don't upload the original (unhashed) files noUploadHashedFiles | boolean | don't upload the hashed files forceUpload | boolean | skip shouldUpload etag modified lookup for keys before uploading; does not override noUpload* options hashedOriginalFileRegexp | RegExp | boolean | respect hashes in original filenames; use this if your webpack output pattern includes [chunkhash] includePseudoUnhashedOriginalFilesInDigest | boolean | add pseudo-entries to the digest for the "unhashed" variant of hashed original files

Example usage

const { S3Sync } = require('s3-asset-uploader')

const config =  {
  key: '<aws-access-key-id>',
  secret: '<aws-secret-access-key>',
  bucket: '<aws-s3-bucket-name>'
}
const options = {
  path: './public',
  ignorePaths: ['js/vendor', '.DS_Store'],
  prefix: 'assets',
  digestFileKey: 'config/asset-map.json'
}

const s3SyncUploader = new S3Sync(config, options)
s3SyncUploader.run()
.then(digest => {
  console.log('S3 Sync complete! Digest: ', digest)
})
.catch(err => {
  console.error('S3 Sync failed: ', err)
})

Debug logging

To see what's going on under the hood, add s3-asset-uploader to your DEBUG environment variable:

DEBUG=s3-asset-uploader

For more information on configuring the debug logger, see: https://github.com/visionmedia/debug#readme