hash-obj/index.d.ts

Get the hash of an object

/* eslint-disable import/export */
import {Encoding as CryptoEncoding} from 'crypto';
import {LiteralUnion} from 'type-fest';

export type Encoding = CryptoEncoding | 'buffer';
export type Algorithm = LiteralUnion<'md5' | 'sha1' | 'sha256' | 'sha512', string>;

export interface Options {
	/**
	Encoding of the returned hash.

	@default 'hex'
	*/
	readonly encoding?: Encoding;

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

	@default 'sha512'
	*/
	readonly algorithm?: Algorithm;
}

export interface BufferOptions extends Options {
	readonly encoding: 'buffer';
}

/**
Get the hash of an object.

@example
```
import hashObject from 'hash-obj';

hashObject({'🦄': '🌈'}, {algorithm: 'sha1'});
//=> '3de3bc784035b559784fc276f47493d60555fba3'
```
*/
export default function hashObject(
	object: Record<string, any>,
	options: BufferOptions
): Buffer;
export default function hashObject(
	object: Record<string, any>,
	options?: Options
): string;