Skip to content
This repository was archived by the owner on Apr 29, 2020. It is now read-only.

Commit b03e83f

Browse files
Alan Shawachingbrain
Alan Shaw
authored andcommitted
docs: add rabin chunker options (#15)
1 parent d3c326d commit b03e83f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,13 @@ The input's file paths and directory structure will be preserved in the [`dag-pb
124124

125125
- `wrap` (boolean, defaults to false): if true, a wrapping node will be created
126126
- `shardSplitThreshold` (positive integer, defaults to 1000): the number of directory entries above which we decide to use a sharding directory builder (instead of the default flat one)
127-
- `chunker` (string, defaults to `"fixed"`): the chunking strategy. Now only supports `"fixed"`
127+
- `chunker` (string, defaults to `"fixed"`): the chunking strategy. Supports:
128+
- `fixed`
129+
- `rabin`
128130
- `chunkerOptions` (object, optional): the options for the chunker. Defaults to an object with the following properties:
129-
- `maxChunkSize` (positive integer, defaults to `262144`): the maximum chunk size for the `fixed` chunker.
131+
- `avgChunkSize` (positive integer, defaults to `262144`): the average chunk size (rabin chunker only)
132+
- `minChunkSize` (positive integer): the minimum chunk size (rabin chunker only)
133+
- `maxChunkSize` (positive integer, defaults to `262144`): the maximum chunk size
130134
- `strategy` (string, defaults to `"balanced"`): the DAG builder strategy name. Supports:
131135
- `flat`: flat list of chunks
132136
- `balanced`: builds a balanced tree

0 commit comments

Comments
 (0)