Skip to content

Commit

Permalink
docs: integrityStream docs were wrong
Browse files Browse the repository at this point in the history
  • Loading branch information
zkat committed Feb 16, 2018
1 parent 5e6fcee commit 38878b7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ ssri.checkStream(
) // -> Promise<Error<{code: 'EINTEGRITY'}>>
```

#### <a name="integrity-stream"></a> `> integrityStream(sri, [opts]) -> IntegrityStream`
#### <a name="integrity-stream"></a> `> integrityStream([opts]) -> IntegrityStream`

Returns a `Transform` stream that data can be piped through in order to generate
and optionally check data integrity for piped data. When the stream completes
Expand Down Expand Up @@ -480,5 +480,5 @@ may intentionally deprioritize algorithms with known vulnerabilities.
```javascript
const integrity = ssri.fromData(fs.readFileSync('index.js'))
fs.createReadStream('index.js')
.pipe(ssri.checkStream(integrity))
.pipe(ssri.integrityStream({integrity}))
```

0 comments on commit 38878b7

Please sign in to comment.