Fingerprint a JSON by calculating the hash (default: sha256) based on the shape of the JSON and its value types.
npm install json-fingerprintimport {fingerprintJSON} from 'json-fingerprint';const {hash, jsonPaths} = fingerprintJSON(`{"foo":"bar"}`)
// hash = 3e61d854042bcd6273a8e18589eb53a37e4cdc111bd2dc717413951637c11e2d
// jsonPaths = ['$:object', '$.foo:string']
const {hash, jsonPaths} = fingerprintJSON(`{"foo":"some string"}`)
// hash = 3e61d854042bcd6273a8e18589eb53a37e4cdc111bd2dc717413951637c11e2d
// jsonPaths = ['$:object', '$.foo:string']// JSON input
fingerprintJSON(`{"foo":"bar"}`)
// object input
fingerprintJSON({"foo":"bar"})
// custom hash function
fingerprintJSON(`{"foo":"bar"}`, myCustomHashFn)const {hash, jsonPaths, source} = fingerprintJSON(`{"foo":"bar"}`)hash: fingerprint hash of the JSONjsonPaths: internal JSON meta data (hash is calculated based on stringified jsonPaths)source: original JSON provided as input
import { createHash } from 'node:crypto';
function sha512(data) {
/**
* https://nodejs.org/api/crypto.html#cryptocreatehashalgorithm-options
* `openssl list -digest-algorithms` to display the available digest algorithms
*/
return createHash('sha512').update(data).digest('hex');
}
fingerprintJSON(`{"foo":"bar"}`, sha512);