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

nodestream-transform-checksum

v0.5.1

Published

Checksum calculator for Nodestream

Downloads

17

Readme

Nodestream - Checksum Transform

NPM Version Build Status Coverage Status Documentation Status Built with GNU Make

Checksum calculator for Nodestream

Identity:: checksum

API docs

Description

This transformer allows you to calculate checksums of the files you upload/download with Nodestream. It can also be used as a standalone library, although it does not provide much in addition to the standard crypto APIs.

Usage

Installation

npm install --save nodestream-transform-checksum

Configuration

You need to register this tranform with Nodestream before you can use it:

// Assuming you already have a nodestream instance configured with an adapter
nodestream.registerTransform('checksum')

Now you can create a pipeline which will use this transform:

const pipeline = nodestream.pipeline()
  .use('checksum', {
    algorithm: 'md5',
    buffer: false
  })

The transform accepts two options:

  • algorithm: Which hashing algorithm should be used. This can be anything that crypto.getHashes() shows on your system.
  • buffer: By default, the resulting hash will be returned as hex string. Set this to true to get the actual raw buffer instead.

Results

This transform will publish its data to the checksum property (this transform's identity) on the results response:

// Uploads
const file = fs.createReadStream('/users/me/profile-pic.png')
pipeline.upload(file, { name: 'avatar.png' })
.then(results => {
  results.checksum.value // The actual hash
  results.checksum.algorithm // The algorithm used
})

// Downloads
const dest = fs.createWriteStream('/users/me/profile-pic.png')
pipeline.download('avatars/user-123.png', dest)
.then(results => {
  results.checksum.value // The actual hash
  results.checksum.algorithm // The algorithm used
})

License

This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.