44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# @pushrocks/smartstream
|
|
simplifies access to node streams
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstream)
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstream)
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartstream)
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartstream/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartstream/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartstream/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smartstream)
|
|
[](https://snyk.io/test/npm/@pushrocks/smartstream)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```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')
|
|
])
|
|
|
|
mySmartstream.onError((err) => { /* handle error */ }) // handles all errors in stream
|
|
myStream.onCustomEvent('myeventname', (args...) => { /* Do something */ }) // emit an custom event anywhere in your stream
|
|
mySmartstream.run().then(() => {/* do something when stream is finished */})
|
|
```
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://maintainedby.lossless.com)
|