Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/vinyl-bufferstream
Deal with vinyl file contents, regardless of whether they are a buffer or stream
https://github.com/shinnn/vinyl-bufferstream
Last synced: 26 days ago
JSON representation
Deal with vinyl file contents, regardless of whether they are a buffer or stream
- Host: GitHub
- URL: https://github.com/shinnn/vinyl-bufferstream
- Owner: shinnn
- License: mit
- Created: 2015-01-20T20:04:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-05-07T02:16:52.000Z (over 8 years ago)
- Last Synced: 2024-09-21T12:23:59.594Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vinyl-bufferstream
[](https://www.npmjs.com/package/vinyl-bufferstream)
[](https://travis-ci.org/shinnn/vinyl-bufferstream)
[](https://ci.appveyor.com/project/ShinnosukeWatanabe/vinyl-bufferstream)
[](https://coveralls.io/r/shinnn/vinyl-bufferstream)
[](https://david-dm.org/shinnn/vinyl-bufferstream)
[](https://david-dm.org/shinnn/vinyl-bufferstream#info=devDependencies)
Deal with [vinyl file](https://github.com/wearefractal/vinyl) contents, regardless of whether they are a Buffer or Stream
```javascript
var through = require('through2');
var VinylBufferStream = require('vinyl-bufferstream');
function yourGulpPlugin() {
var vinylBufferStream = new VinylBufferStream(function(buf, done) {
syncOrAsyncFn(buf, done);
});
return through.obj(function(file, enc, cb) {
var self = this;
vinylBufferStream(file, function(err, contents) {
if (err) {
self.emit('error', err);
} else {
file.contents = contents;
self.push(file);
}
cb();
});
});
}
```
## Installation
[Use npm.](https://docs.npmjs.com/cli/install)
```sh
npm install vinyl-bufferstream
```
## API
```javascript
var VinylBufferStream = require('vinyl-bufferstream');
```
### vinylBufferStream = new VinylBufferStream(*transformFunction*)
(`new` operator is optional.)
*transformFunction*: `Function`
Return: `Function`
The argument must be a function taking a [`Buffer`][buffer] and a callback function as it's first and second arguments, respectively. The callback will be invoked with [Node](http://nodejs.org/)-style callback arguments (`error, result`), where `result` is the buffered `file.contents`.
#### vinylBufferStream(*file*, *callback*)
*file*: `Object` ([vinyl file](https://github.com/wearefractal/vinyl#file) object)
*callback*: `Function`
When `file.contents` is a [`Buffer`][buffer], it will call *transformFunction*, passing file.contents as the first argument.
When `file.contents` is a [`Stream`][buffer], it will call *transformFunction*, passing the buffered `file.contents` as the first argument.
When `file.contents` is`null`, it won't call the *transformFunction*.
##### callback(err, contents)
*error*: `Error` or `null`
*contents*: [`Buffer`][buffer] or [`Stream`][stream]
When `file.contents` is a [`Buffer`][buffer], *contents* will be a result that *transformFunction* produces.
When `file.contents` is a [`Stream`][stream], *contents* will be a stream that emits the data *transformFunction* produces.
When `file.contents` is `null`, *contents* will be `null`.
```javascript
var gulp = require('gulp');
var SVGO = require('svgo');
var through = require('through2');
var VinylBufferStream = require('vinyl-bufferstream');
function svgminPlugin(options) {
var svgo = new SVGO(options);
var vinylBufferStream = new VinylBufferStream(function(buf, done) {
svgo.optimize(String(buf), function(result) {
if (result.error) {
done(result.error);
return;
}
done(null, result.data);
});
});
return through.obj(function(file, enc, cb) {
vinylBufferStream(file, function(err, contents) {
if (err) {
self.emit('error', err);
} else {
file.contents = contents;
self.push(file);
}
cb();
});
});
}
gulp.task('buffer', function() {
return gulp.src('*.svg')
.pipe(svgminPlugin())
.pipe(gulp.dest('dest'));
});
gulp.task('stream', function() {
return gulp.src('*.svg', {buffer: false})
.pipe(svgminPlugin())
.pipe(gulp.dest('dest'));
});
```
## License
Copyright (c) 2014 - 2016 [Shinnosuke Watanabe](https://github.com/shinnn)
Licensed under [the MIT License](./LICENSE).
[buffer]: https://nodejs.org/api/buffer.html
[stream]: https://nodejs.org/api/stream.html