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-deleter

v0.1.2

Published

A writable stream that deletes files from S3 via knox

Downloads

5,442

Readme

S3-Deleter

A writable stream that batch-deletes files from s3, via the excellent knox. Designed for use with s3-lister.

Examples

These code snippets show some of the things you can do with two streams and a knox client.

Deleting all the files in a folder:

var client = knox.createClient({
  key    : '<api-key-here>',
  secret : '<secret-here>',
  bucket : 'great-bucket'
});

var lister = new S3Lister(client, {prefix : 'folder/i/dislike'});
var deleter = new S3Deleter(client);

deleter
  .on('error',  function (err) { console.log('Error!!', err); })
  .on('finish', function ()    { console.log 'All done!' });
lister.pipe(deleter);

Deleting all the files in a bucket that are more than one week old:

var client = knox.createClient({
  key    : '<api-key-here>',
  secret : '<secret-here>',
  bucket : 'great-bucket'
});

var lister = new S3Lister(client);
var deleter = new S3Deleter(client);

deleter
  .on('error',  function (err) { console.log('Error!!', err); })
  .on('finish', function ()    { console.log 'All done!' });

var oneWeekAgo = Date.now() - 1000 * 60 * 60 * 24 * 7;
lister
  .on('error', function (err)  { console.log('Error!!', err); })
  .on('end',   function ()     { deleter.end(); })
  .on('data',  function (file) {
    if (parseInt(file.LastModified) < oneWeekAgo) {
      deleter.write(file);
    }
  });

Usage

new S3Deleter(client, options)

  • client - a knox client
  • options - hash of options

In addition to the standard writable stream settings, S3Deleter supports:

  • batchSize - size of batches to delete at a time, up to 1000

Running Tests

To run the test suite, create a file named ./test/auth.json, containing your S3 bucket credentials as a JSON, a la:

{
  "bucket": "my-bucket",
  "region": "us-standard",
  "key": "<api-key>",
  "secret": "<secret-key>"
}