Skip to content

Commit ca8583e

Browse files
committed
README: rephrase description of interruptStep
1 parent d0f5d9f commit ca8583e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ calculation, avoiding setImmediate.
6666
* `r` — block size parameter
6767
* `p` — parallelization parameter (default is 1)
6868
* `dkLen` — derived key length (default is 32)
69-
* `interruptStep` — (optional) steps to split calculation with timeouts (defaults to 0)
69+
* `interruptStep` — (optional) the amount of loop cycles to execute before the next setImmediate/setTimeout (defaults to 0)
7070
* `encoding` — (optional) result encoding `'base64'` or `'hex'` (result with be a `string`), `'binary'` (result will be a `Uint8Array`) or undefined (result will be an `Array` of bytes).
7171

7272
#### Example:
@@ -96,7 +96,7 @@ Legacy API doesn't support parallelization parameter greater than 1.
9696
* *logN* — CPU/memory cost parameter (1 to 31)
9797
* *r* — block size parameter
9898
* *dkLen* — length of derived key
99-
* *interruptStep* — (optional) steps to split calculation with timeouts (defaults to 1000)
99+
* *interruptStep* — (optional) the amount of loop cycles to execute before the next setImmediate/setTimeout (defaults to 1000)
100100
* *callback* — callback function receiving result (`function (Array|Uint8Array|string)`)
101101
* *encoding* — (optional) result encoding (`'base64'`, `'hex'`, `'binary'` or undefined).
102102

0 commit comments

Comments
 (0)