Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 1 KB

readme.md

File metadata and controls

46 lines (36 loc) · 1 KB

#vinyl-string Build Status

For the terminally lazy

###constructor(fileContents, options)

fileContents

The contents of the pretend file

Type: String or Buffer

options

An options object for the creation of a vinyl file.

options.keepOpen

Set to true to keep the stream open. Use when piping /into/ the vinyl-string object.

###example

var vs = require('vinyl-string');
var vFile = vs(
  "my file contents!",
  {
    path: "filename.txt"
  }
);

vFile.pipe(gulp.dest("./output"));
/* if vFile is also a stream destination, set keepOpen: true */
var vs = require('vinyl-string');
var vFile = vs(
  "my file contents!",
  {
    path: "filename.txt",
    keepOpen: true // allow piping in to vFile
  }
);

gulp.src(["./src/*.txt"])
  .pipe(vFile)
  .pipe(gulp.dest("./output");