UNPKG

create-hmac/README.md

Version:

1.08 kBMarkdownView Raw

1# create-hmac
2
3[![NPM Package](https://img.shields.io/npm/v/create-hmac.svg?style=flat-square)](https://www.npmjs.org/package/create-hmac)
4[![Build Status](https://img.shields.io/travis/crypto-browserify/createHmac.svg?branch=master&style=flat-square)](https://travis-ci.org/crypto-browserify/createHmac)
5[![Dependency status](https://img.shields.io/david/crypto-browserify/createHmac.svg?style=flat-square)](https://david-dm.org/crypto-browserify/createHmac#info=dependencies)
6
7[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
8
9Node style HMACs for use in the browser, with native HMAC functions in node. API is the same as HMACs in node:
10
11```js
12var createHmac = require('create-hmac')
13var hmac = createHmac('sha224', Buffer.from('secret key'))
14hmac.update('synchronous write') //optional encoding parameter
15hmac.digest() // synchronously get result with optional encoding parameter
16
17hmac.write('write to it as a stream')
18hmac.end() //remember it's a stream
19hmac.read() //only if you ended it as a stream though
20```

1	`# create-hmac`
2
3	`[![NPM Package](https://img.shields.io/npm/v/create-hmac.svg?style=flat-square)](https://www.npmjs.org/package/create-hmac)`
4	`[![Build Status](https://img.shields.io/travis/crypto-browserify/createHmac.svg?branch=master&style=flat-square)](https://travis-ci.org/crypto-browserify/createHmac)`
5	`[![Dependency status](https://img.shields.io/david/crypto-browserify/createHmac.svg?style=flat-square)](https://david-dm.org/crypto-browserify/createHmac#info=dependencies)`
6
7	`[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)`
8
9	`Node style HMACs for use in the browser, with native HMAC functions in node. API is the same as HMACs in node:`
10
11	```js
12	`var createHmac = require('create-hmac')`
13	`var hmac = createHmac('sha224', Buffer.from('secret key'))`
14	`hmac.update('synchronous write') //optional encoding parameter`
15	`hmac.digest() // synchronously get result with optional encoding parameter`
16
17	`hmac.write('write to it as a stream')`
18	`hmac.end() //remember it's a stream`
19	`hmac.read() //only if you ended it as a stream though`
20	```