2016-08-16 06:40:54 +00:00
|
|
|
# smartstream
|
|
|
|
|
simplifies access to node streams, TypeScript ready!
|
|
|
|
|
|
2016-09-25 14:10:06 +00:00
|
|
|
## Availabililty
|
|
|
|
|
[](https://www.npmjs.com/package/smartstream)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartstream)
|
|
|
|
|
[](https://github.com/pushrocks/smartstream)
|
|
|
|
|
[](https://pushrocks.gitlab.io/smartstream/gitbook)
|
|
|
|
|
|
|
|
|
|
## Status for master
|
2016-08-16 06:40:54 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartstream/commits/master)
|
2016-09-25 14:10:06 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartstream/commits/master)
|
|
|
|
|
[](https://david-dm.org/pushrocks/smartstream)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartstream/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartstream)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](http://standardjs.com/)
|
2016-08-16 06:40:54 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
We recommend the use of TypeScript for best in class intellisense support.
|
|
|
|
|
|
2016-09-25 14:10:06 +00:00
|
|
|
```typescript
|
|
|
|
|
import { Smartstream } from 'smartstream'
|
|
|
|
|
import * as gUglify from 'gulp-uglify'
|
|
|
|
|
|
|
|
|
|
let mySmartstream = new Smartstream([
|
|
|
|
|
gulp.src(['./file1.js','./file2.js']),
|
|
|
|
|
gUglify(),
|
|
|
|
|
gulp.dest('./some/output/path')
|
|
|
|
|
])
|
|
|
|
|
|
2016-09-25 14:28:42 +00:00
|
|
|
mySmartstream.onError((err) => { /* handle error */ }) // handles all errors in stream
|
|
|
|
|
myStream.onCustomEvent('myeventname', (args...) => { /* Do something */ }) // emit an custom event anywhere in your stream
|
2016-09-25 14:10:06 +00:00
|
|
|
mySmartstream.run().then(() => {/* do something when stream is finished */})
|
|
|
|
|
```
|
|
|
|
|
|
