3.0.1 • Published 1 year ago

@tadashi/hash v3.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

hash

NPM version Node.js CI Coverage Status

XO code style

Create a hash from any data (Node.js).
Create a hash from string (Browser).

Install

$ npm i @tadashi/hash

API (Node.js)

hash(data, options)

Return: Buffer | string

data

Type: string | Buffer | TypedArray | DataView
Default: -

options

Type: Object
Default: see below

parametertyperequireddefaultdescription
algstringnosha256algorithm
encodingstringno-encoding of the return value

API (Browser)

hash(data, options)

Return: Promise\<string|Buffer>

data

Type: string
Default: -

options

Type: Object
Default: see below

parametertyperequireddefaultdescription
algstringnosha256algorithm
asBufferbooleannofalsereturn hash as buffer

Usage

Via Node

import hash from '@tadashi/hash'

const data = hash('test', {encoding: 'hex'})
// => 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08

Via Browser

⚠️ Warning

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

import hash from 'https://unpkg.com/@tadashi/hash@{version}/src/browser.js'

const data = await hash('test', {encoding: 'hex'})
// => 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08

License

MIT © Thiago Lagden