linwenling
2023-09-12 2eec82ffc96ae02a75b18ee2c426f7a162950b95
node_modules/object-hash/readme.markdown
@@ -30,7 +30,9 @@
## hash(value, options);
Generate a hash from any object or type.  Defaults to sha1 with hex encoding.
*  `algorithm` hash algo to be used: 'sha1', 'md5'. default: sha1
*  `algorithm` hash algo to be used: 'sha1', 'md5', 'passthrough'. default: sha1
  *  This supports the algorithms returned by `crypto.getHashes()`. Note that the default of SHA-1 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
  * This also supports the `passthrough` algorith, which will return the information that would otherwise have been hashed.
*  `excludeValues` {true|false} hash object keys, values ignored. default: false
*  `encoding` hash encoding, supports 'buffer', 'hex', 'binary', 'base64'. default: hex
*  `ignoreUnknown` {true|*false} ignore unknown object types. default: false
@@ -49,6 +51,8 @@
## hash.sha1(value);
Hash using the sha1 algorithm.
Note that SHA-1 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
*Sugar method, equivalent to hash(value, {algorithm: 'sha1'})*
## hash.keys(value);
@@ -59,10 +63,14 @@
## hash.MD5(value);
Hash using the md5 algorithm.
Note that the MD5 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
*Sugar method, equivalent to hash(value, {algorithm: 'md5'})*
## hash.keysMD5(value);
Hash object keys using the md5 algorithm, values ignored.
Note that the MD5 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
*Sugar method, equivalent to hash(value, {algorithm: 'md5', excludeValues: true})*
@@ -167,3 +175,10 @@
## License
MIT
## Changelog
### v2.0.0
Only Node.js versions `>= 6.0.0` are being tested in CI now.
No other breaking changes were introduced.