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

@1n/file-hash

v0.0.2

Published

Get the hash-sum of a given file, with low memory usage, even on huge file

Downloads

976

Readme

@1n/file-hash

Get the hash-sum of a given file, with low memory usage, even on huge files.

Installation

npm install --save @1n/file-hash

Usage

Sync usage

import { hash, hashSync } from '@1n/file-hash'

const code = hash('package.json') // md5
const code = hash('package.json', 'sha256') // sha256
const code = hash('package.json', { algorithm: 'sha256' }) // sha256

const code = hashSync('package.json') // md5
const code = hashSync('package.json', 'sha256') // sha256
const code = hashSync('package.json', { algorithm: 'sha256' }) // sha256

console.log(`The hash sum of package.json is: ${code}`)

Async usage

import { hash, hashAsync } from '@1n/file-hash'

const code = await hash('package.json', { async: true }) // md5
const code = await hash('package.json', {
  async: true,
  algorithm: 'sha256'
}) // sha256

const code = await hashAsync('package.json') // md5
const code = await hashAsync('package.json', 'sha256') // sha256
const code = await hashAsync('package.json', { algorithm: 'sha256' }) // sha256

console.log(`The hash sum of package.json is: ${code}`)

API

Types

type HashAlgorithm = 'md5' | 'sha1' | 'sha256' | 'sha512'
interface HashOptions<Async extends boolean = boolean> {
  async?: Async
  algorithm?: HashAlgorithm
}

Sync api

Synchronously get the hash-sum of the file at filePath.

import { hash } from '@1n/file-hash'

hash(
  filePath: string, 
  algorithm?: HashAlgorithm = 'md5'
): string

hash(
  filePath: string, 
  options?: {
    async?: false
    algorithm?: HashAlgorithm = 'md5'
  }
): string
import { hashSync } from '@1n/file-hash'

hashSync(
  filePath: string, 
  algorithm?: HashAlgorithm = 'md5'
): string

hashSync(
  filePath: string, 
  options?: {
    async?: false
    algorithm?: HashAlgorithm = 'md5'
  }
): string

Async api

Asynchronously get the hash-sum of the file at filePath.

Returns a Promise that will be resolved with a string containing the algorithm.

import { hash } from '@1n/file-hash'

hash(
  filePath: string, 
  options?: {
    async: true
    algorithm?: HashAlgorithm = 'md5'
  }
): Promise<string>
import { hashAsync } from '@1n/file-hash'

hashAsync(
  filePath: string, 
  algorithm?: HashAlgorithm = 'md5'
):Promise<string>

hashAsync(
  filePath: string, 
  options?: {
    async?: true
    algorithm: HashAlgorithm = 'md5'
  }
): Promise<string>

License

MIT