Skip to content

Commit 38878b7

Browse files
committed
docs: integrityStream docs were wrong
1 parent 5e6fcee commit 38878b7

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
@@ -445,7 +445,7 @@ ssri.checkStream(
445445
) // -> Promise<Error<{code: 'EINTEGRITY'}>>
446446
```
447447

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

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

0 commit comments

Comments
 (0)