@arve.knudsen/multihashes
v0.4.15
Published
multihash implementation
Downloads
3
Readme
js-multihash
multihash implementation in node.js
This is the multihash implementation in Node.
Lead Maintainer
Table of Contents
Install
Using npm
> npm install --save multihashes # node the name of the module is multihashes
Once the install is complete, you can require it as a normal dependency
const multihashes = require('multihashes')
You can require it and use with your favourite bundler to bundle this package in a browser compatible code.
Using a <script>
tag
Loading this module through a script tag will make the Multihashes
obj available in the global namespace.
<script src="https://unpkg.com/multihashes/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/multihashes/dist/index.js"></script>
Gotchas
You will need to use Node.js Buffer
API compatible, if you are running inside the browser, you can access it by multihash.Buffer
or you can install Feross's Buffer.
Usage
> var multihash = require('multihashes')
> var buf = new Buffer('0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33', 'hex')
> var encoded = multihash.encode(buf, 'sha1')
> console.log(encoded)
<Buffer 11 14 0b ee c7 b5 ea 3f 0f db c9 5d 0d d4 7f 3c 5b c2 75 da 8a 33>
> multihash.decode(encoded)
{ code: 17,
name: 'sha1',
length: 20,
digest: <Buffer 0b ee c7 b5 ea 3f 0f db c9 5d 0d d4 7f 3c 5b c2 75 da 8a 33> }
API
https://multiformats.github.io/js-multihash/
Contribute
Contributions welcome. Please check out the issues.
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.
License
MIT © 2016 Protocol Labs Inc.