Skip to content

Fixing clerical errors #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
q2s2t merged 1 commit into from
Dec 14, 2018
Merged

Fixing clerical errors #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
import Seven from 'node-7z'

// myStream is an Readable stream
const myStream = Seven.extractFull('./archive.7z', './output/dir/')
const myStream = Seven.extractFull('./archive.7z', './output/dir/', { $progress: true })
.on('data', function (data) {
doStuffWith(data) //? { status: 'extracted', file: 'extracted/file.txt" }
})
.on('progresss', function (progress) {
.on('progress', function (progress) {
doStuffWith(progress) //? { percent: 67, fileCount: 5, file: undefinded }
})
.on('end', function () {
Expand Down Expand Up @@ -47,7 +47,7 @@ const myStream = Seven.extractFull('./archive.7z', './output/dir/')
npm install --save node-7z
```

You should have the a 7-Zip executable (v16.04 or greater) available in your system.
You should have the a 7-Zip executable (v16.02 or greater) available in your system.

> - On Debian and Ubuntu install the p7zip-full package.
> - On Mac OSX use Homebrew `brew install p7zip`
Expand Down Expand Up @@ -273,7 +273,7 @@ Those options are not provided by 7-Zip but are features of this module.

| Name | Type | Description |
|-----------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| `$progress` | `boolean` | Progress percentage gets fired. Shortcut for `{ outputStreams: ['b1'] }` |
| `$progress` | `boolean` | Progress percentage gets fired. Shortcut for `{ outputStreams: ['b1'] }` Use if you want access to the `progress` event. |
| `$defer` | `boolean` | Create the stream but do not spawn child process |
| `$childProcess` | [`ChildProcess`](https://nodejs.org/api/child_process.html#child_process_class_childprocess) | Attach an external child process to be parsed |
| `$bin` | `string` | Path to an other 7-Zip binary. Default: `7z` |
Expand Down Expand Up @@ -411,4 +411,4 @@ With :heart: from [quentinrossetti](http://quentinrossetti.me/)
[maintainability-url]: https://codeclimate.com/github/quentinrossetti/node-7z
[maintainability-image]: https://img.shields.io/codeclimate/maintainability/quentinrossetti/node-7z.svg
[vulnerabilities-image]: https://snyk.io/test/github/quentinrossetti/node-7z/badge.svg?targetFile=package.json
[vulnerabilities-url]: https://snyk.io/test/github/quentinrossetti/node-7z?targetFile=package.json
[vulnerabilities-url]: https://snyk.io/test/github/quentinrossetti/node-7z?targetFile=package.json