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-block-read-stream

v0.5.0

Published

Readable stream for S3 object divided into blocks by partial download with the range

Downloads

188

Readme

S3BlockReadStream

NPM Version Build Status codecov

A S3 readable stream is downloading an object divided into blocks by partial download with the range header.

  • It is possible to prevent a broken connection of long-time against S3 normal stream.
  • You can adjust a download speed on flowing mode by editing the interval.
  • Node.js 6.10 or Later

How to Install

$ npm install s3-block-read-stream

How to Use

const AWS = require('aws-sdk');
const S3BlockReadStream = require('s3-block-read-stream');

new S3BlockReadStream(new AWS.S3({ apiVersion: '2006-03-01' }), {
  Bucket: 'test-bucket',
  Key: 'something.txt',
  // any other params of AWS.S3.getObject method
}, {
  interval: 1000, // interval for each http request (default is 0 millsecond)
  blockSize: 64 * 1024 * 1024 // download partial content block size at once (default is 64MB)
})
.pipe(process.stdout);
  • Attention to increasing API requests if blockSize is too small

Output progress information

Pass logCallback parameter to the second argument for constructor

new S3BlockReadStream(new AWS.S3({ apiVersion: '2006-03-01' }), {
  Bucket: 'test-bucket',
  Key: 'foo/bar.txt'
}, {
  logCallback: function(msg) {
    console.warn(msg)
  }
})
.pipe(process.stdout);
$ node example.js > /dev/null
test-bucket/foo/bar.txt - Start
test-bucket/foo/bar.txt - File Size: 1654534
test-bucket/foo/bar.txt - Download Range: bytes=0-1654533
test-bucket/foo/bar.txt - Received Size: 1654534
test-bucket/foo/bar.txt - Done

Example

Downloading CSV file, converting into JSON and printing stdout

const AWS = require('aws-sdk');
const csv = require('csv');
const S3BlockReadStream = require('s3-block-read-stream');

const readStream = new S3BlockReadStream(new AWS.S3({ apiVersion: '2006-03-01' }), {
  Bucket: 'your-bucket',
  Key: 'something.csv'
});

readStream.pipe(csv.parse())
  .pipe(csv.transform(function(record){
     return JSON.stringify(record, null, 2) + '\n';
  }))
  .pipe(process.stdout);

License

MIT