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-unzip-uuid

v0.1.17

Published

Utility for unzipping a compressed (application/zip) file from a S3 bucket's root directory back to the same bucket.

Downloads

13

Readme

S3 Unzip

A simple library to unzip an archive file in a S3 bucket to its root folder.

Install

  • To include as library: npm install s3-unzip
  • To use as a command-line tool: npm install -g s3-unzip

Restrictions

  • The module only supports the input zip file MIME type of 'application/zip'.

Command Line Usage

s3-unzip [-dv] <bucket name> <filename>

Required

  • <bucket name> : Bucket name in S3 where the zip file exists
  • <filename> : Filename (including the .zip extension) of the archive that will be decompressed

Options

  • -d, --delete-on-success : Delete the zip file once the decompression has finished
  • -v, --verbose : Show the console log messages during runtime

Example

s3-unzip -d -v test-bucket-in-s3 Companies.zip

Library Usage

Include like most libraries:

var s3Unzip = require("s3-unzip");

Run the decompression for the file in the specified bucket:

Options

var s = new s3Unzip({
    bucket: "test-bucket-in-s3",
    file: "Companies.zip",
    deleteOnSuccess: true,
    verbose: false
  }, function(err, success){
    if (err) console.error(err);
    else console.log(success);
  });

AWS Lambda Usage

Create an AWS Lambda function, name it, and zip all files from this package to upload the code (including node_modules). The function defaults to deleting the zip file after it's been decompressed and verbose messages logged to CloudWatch.

Configuration

Basic
  • Runtime: Node.js 6.10
  • Handler: index.handler
  • Role: (create a custom role with Full S3 Access)
Advanced

For a 20MB zip file:

  • Memory: at least 512MB
  • Timeout: at least 30 sec

Options

Test JSON:

{
  "event":{
    "Records": [
      {
        "s3": {
          "bucket": {
            "name": "test-bucket-in-s3"
          },
          "object": {
            "key": "Companies.zip"
          }
        }
      }
    ]
  }
}