Skip to content

Commit

Permalink
docs: update README with new options
Browse files Browse the repository at this point in the history
  • Loading branch information
@MarshallOfSound
MarshallOfSound committed Sep 7, 2021
1 parent d04670c commit 927723a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,11 @@ precisely represent UINT64 in JavaScript `Number`. `size` is a JavaScript
because file size in Node.js is represented as `Number` and it is not safe to
convert `Number` to UINT64.

`integrity` is an object consisting of a hashing `algorithm` and a hex encoded
`hash` value.
`integrity` is an object consisting of a few keys:
* A hashing `algorithm`, currently only `SHA256` is supported.
* A hex encoded `hash` value representing the hash of the entire file.
* An array of hex encoded hashes for the `blocks` of the file. i.e. for a blockSize of 4KB this array contains the hash of every block if you split the file into N 4KB blocks.
* A integer value `blockSize` representing the size in bytes of each block in the `blocks` hashes above

[pickle]: https://chromium.googlesource.com/chromium/src/+/master/base/pickle.h
[node-pickle]: https://www.npmjs.org/package/chromium-pickle
Expand Down

0 comments on commit 927723a

Please sign in to comment.