JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14023
  • Score
    100M100P100Q144793F
  • License MIT

Just enough code to calculate the IPFS hash for some data

Package Exports

  • ipfs-only-hash

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipfs-only-hash) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ipfs-only-hash

Build Status dependencies Status JavaScript Style Guide

Just enough code to calculate the IPFS hash for some data

Calculate the IPFS hash for some data without having to install or run an IPFS node. Try it out with npx:

npx ipfs-only-hash <path to file>

Install

npm i ipfs-only-hash

Usage

From the command line

ipfs-only-hash <file>

# or pipe in 
echo "hello world" | ipfs-only-hash

As a library

const Hash = require('ipfs-only-hash')
const data = 'hello world!'
const hash = await Hash.of(data)
console.log(hash) // QmTp2hEo8eXRp6wg7jXv1BLCMh5a4F3B7buAUZNZUu772j

API

const Hash = require('ipfs-only-hash')

Hash.of(input, options?): Promise<string>

Calculate the hash for the provided input.

  • input (string|Uint8Array|AsyncIterable<Uint8Array>): The input bytes to calculate the IPFS hash for. Note that Node.js readable streams are async iterable!
  • options (Object): Optional options passed directly to the ipfs-unixfs-importer module. See the API docs for possible values.

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Alan Shaw