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

unpack-stream

v6.0.0

Published

Unpack a tarball stream

Downloads

575

Readme

unpack-stream

Unpack a tarball stream

npm version Build Status

Installation

npm i -S unpack-stream

Usage

'use strict'
const got = require('got')
const unpackStream = require('unpack-stream')

const tarball = 'https://registry.npmjs.org/is-negative/-/is-negative-2.1.0.tgz'
const stream = got.stream(tarball)
unpackStream.remote(stream, './tmp')
  .then(index =>
    Promise.all(
      Object.keys(index)
        .map(filename =>
          index[filename].generatingIntegrity.then(integrity => ({filename, integrity})))
    )
  )
  .then(files => console.log(files))
  //> [ { filename: 'package.json',
  //      integrity: 'sha512-RA0APKvtxz85WYCFX3M/TkVeJZZBcylEwh+GrV7uO/NNJO4G3rzgTrpsypp9AU2hM2QBk9SxCHi1Gb9aaWzpYg==' },
  //    { filename: 'index.js',
  //      integrity: 'sha512-3dL1OHn8VWhVDT37f3ZBdou4NrYq2ll//W1lWqx7+4tKBW/WqUx3mDcGyqrBfBeWTIPCd+RiUdF7hp3MQYB9+g==' },
  //    { filename: 'license',
  //      integrity: 'sha512-lSw93JVg7wfwyVXKrg6yIFjF9Bidgr+tA/l6XNlrRhjnE6NhwkyPL3xNL47OZScS8qoQkYUwE6slmo7jGesH0Q==' },
  //    { filename: 'readme.md',
  //      integrity: 'sha512-fM882axp7XaC6nzj5XYuzB0KhYpYwwsR3RjyiqOcIrI6C0b9KxrEEug9VpKTfbSbqTOmZ2KEqZLPKrMXFW1Y+g==' } ]

API

remote(stream, destination, [opts]): Promise<Index>

Unpacks a remote stream fetched via HTTP.

Arguments:

  • stream - Stream
  • destination - string - the directory to which the stream will be unpacked
  • [opts.shasum] - string - shasum to verify tarball
  • [opts.onStart] - Function - called on download start
  • [opts.onProgress] - (downloaded, size) => void - tracks the download progress
  • [opts.generateIntegrity] - Boolean - true by default. If true, generates Subresource Integrity for each unpacked file
  • [opts.ignore] - (filename: string) => boolean - a function that decides whether a file should be unpacked from the tarball.

local(stream, destination, [opts]): Promise<Index>

Unpacks a stream from the local filesystem.

Arguments:

  • [opts.generateIntegrity] - Boolean - true by default. If true, generates Subresource Integrity for each unpacked file
  • [opts.ignore] - (filename: string) => boolean - a function that decides whether a file should be unpacked from the tarball.

License

MIT © Zoltan Kochan