# vinyl-bufferstream

> Deal with vinyl file contents, regardless of whether it is Buffer/Stream

Latest version **1.0.1** (published 2015-02-11) · 0 weekly downloads

## Install

```sh
npm install vinyl-bufferstream
pnpm add vinyl-bufferstream
yarn add vinyl-bufferstream
bun add vinyl-bufferstream
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-02-11 |
| First published | 2015-01-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Shinnosuke Watanabe |
| Maintainers | shinnn |
| Keywords | gulpfriendly, gulp, vinyl, buffer, stream, compatibility, interchangeability, internal, helper |

## Links

- npm: https://www.npmjs.com/package/vinyl-bufferstream
- Repository: https://github.com/shinnn/vinyl-bufferstream
- Issues: https://github.com/shinnn/vinyl-bufferstream/issues
- npm.io page: https://npm.io/package/vinyl-bufferstream

## Dependencies (1)

- [bufferstreams](https://npm.io/package/bufferstreams.md) 1.0.1

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2015-02-11
- 1.0.0 — 2015-01-20
- 0.0.0 — 2015-01-20

## README

# vinyl-bufferstream

[![NPM version](https://img.shields.io/npm/v/vinyl-bufferstream.svg?style=flat)](https://www.npmjs.com/package/vinyl-bufferstream)
[![Build Status](https://img.shields.io/travis/shinnn/vinyl-bufferstream.svg?style=flat)](https://travis-ci.org/shinnn/vinyl-bufferstream)
[![Build status](https://ci.appveyor.com/api/projects/status/gqc8t4mju49p6fkn?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/vinyl-bufferstream)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/vinyl-bufferstream.svg?style=flat)](https://coveralls.io/r/shinnn/vinyl-bufferstream)
[![Dependency Status](https://img.shields.io/david/shinnn/vinyl-bufferstream.svg?style=flat&label=deps)](https://david-dm.org/shinnn/vinyl-bufferstream)
[![devDependency Status](https://img.shields.io/david/dev/shinnn/vinyl-bufferstream.svg?style=flat&label=devDeps)](https://david-dm.org/shinnn/vinyl-bufferstream#info=devDependencies)

Deal with [vinyl file](https://github.com/wearefractal/vinyl) contents, regardless of whether it is Buffer/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) {
    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 its first and second argument, which calls the callback function with passing [Node](http://nodejs.org/)-style callback arguments (`error, result`).

#### vinylBufferStream(*file*, *callback*)

*file*: `Object` ([vinyl file](https://github.com/wearefractal/vinyl#file) object)  
*callback*: `Function`

When the [`file.contents`](https://github.com/wearefractal/vinyl#optionscontents) is a [`Buffer`][buffer], it will call the *transformFunction* with passing file.contents to the first argument.

When the `file.contents` is a [`Stream`][buffer], it will call the *transformFunction* with passing the buffered stream of file.contents to the first argument.

When the `file.contents` is a [`Stream`][stream], it won't call the *transformFunction*.

##### callback(err, contents)

*error*: `Error` or `null`  
*contents*: [`Buffer`][buffer] or [`Stream`][stream]

When the `file.contents` is a [`Buffer`][buffer], *contents* will be a result that *transformFunction* produces.

When the `file.contents` is a [`Stream`][stream], *contents* will be a stream that emits a data *transformFunction* produces.

When the `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 - 2015 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).

[buffer]: https://iojs.org/api/buffer.html#buffer_class_buffer
[stream]: https://iojs.org/api/stream.html

---
_Source: https://npm.io/package/vinyl-bufferstream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._