https://github.com/sindresorhus/hash-object

Get the hash of an object
https://github.com/sindresorhus/hash-object

Last synced: about 2 months ago
JSON representation

Get the hash of an object

• Host: GitHub
• URL: https://github.com/sindresorhus/hash-object
• Owner: sindresorhus
• License: mit
• Created: 2015-07-11T13:11:15.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-11-14T19:36:58.000Z (11 months ago)
• Last Synced: 2024-04-13T19:53:35.752Z (5 months ago)
• Language: JavaScript
• Size: 17.6 KB
• Stars: 131
• Watchers: 8
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# hash-object

> Get the hash of an object

## Install

```sh

npm install hash-object

```

## Usage

```js

import hashObject from 'hash-object';

hashObject({'🦄': '🌈'}, {algorithm: 'sha1'});

//=> '3de3bc784035b559784fc276f47493d60555fba3'

```

## API

### hashObject(object, options?)

The output is deterministic for repeated runs on the same Node.js / browser version. It should also be fairly deterministic across JavaScript engines. However, because the stability of grapheme clusters across Unicode versions is not guaranteed, determinism cannot be guaranteed across JavaScript engines and versions. There are also other factors that can make it nondeterministic, like values with floating point numbers and dates.

#### object

Type: `object`

#### options

Type: `object`

##### encoding

Type: `'hex' | 'base64' | 'buffer' | 'latin1'`\

Default: `'hex'`

The encoding of the returned hash.

##### algorithm

Type: `string`\

Default: `'sha512'`\

Values: `'md5' | 'sha1' | 'sha256' | 'sha512' | …` *([Platform dependent](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm))*

*Don't use `'md5'` or `'sha1'` for anything sensitive. [They're insecure.](http://googleonlinesecurity.blogspot.no/2014/09/gradually-sunsetting-sha-1.html)*

## Related

- [hasha](https://github.com/sindresorhus/hasha) - Hashing made simple. Get the hash of a buffer/string/stream/file.