Skip to content

Commit

Permalink
README: rephrase description of interruptStep
Browse files Browse the repository at this point in the history
  • Loading branch information
dchest committed Apr 26, 2017
1 parent d0f5d9f commit ca8583e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -66,7 +66,7 @@ calculation, avoiding setImmediate.
* `r` — block size parameter
* `p` — parallelization parameter (default is 1)
* `dkLen` — derived key length (default is 32)
* `interruptStep` — (optional) steps to split calculation with timeouts (defaults to 0)
* `interruptStep` — (optional) the amount of loop cycles to execute before the next setImmediate/setTimeout (defaults to 0)
* `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).

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

Expand Down

0 comments on commit ca8583e

Please sign in to comment.