https://github.com/thlorenz/show-stream-progress

Shows progress of any async operation that streams results.
https://github.com/thlorenz/show-stream-progress

Last synced: 26 days ago
JSON representation

Shows progress of any async operation that streams results.

• Host: GitHub
• URL: https://github.com/thlorenz/show-stream-progress
• Owner: thlorenz
• License: other
• Created: 2013-03-17T21:21:34.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-12-12T03:28:51.000Z (about 11 years ago)
• Last Synced: 2024-11-23T03:14:15.101Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 762 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# show-stream-progress [![build status](https://secure.travis-ci.org/thlorenz/show-stream-progress.png)](http://travis-ci.org/thlorenz/show-stream-progress)

Shows progress of any async operation that streams results.

```js

var showProgress =  require('show-stream-progress')

  , browserify   =  require('browserify')

browserify()

  .require(require.resolve('./entry.js'), { entry: true })

  .bundle({ debug: true })

  .pipe(showProgress(process.stderr))

  .pipe(fs.createWriteStream('./bundle.js'))

  ;

```

```

................................................................................

```

Although this example shows how to use this while building a bundle with browserify, show-stream-progress works with any

stream.

**Note:** Actual output subject to change depending on browserify version. I make no guarantees ;)

## Installation

    npm i show-stream-progress

## Demo

    npm explore show-stream-progress

    npm run demo

## API

```

/**

 * @name showProgress

 * @function

 * @param out {Stream} The stream to output progress indicators to, defaults to process.stdout.

 * @return {Stream} Readable and writable stream that just passes along data written to it.

 */

```