Extends vinyl files with properties used in vinyl-collections.
Install with npm:
$ npm install --save vinyl-item
Use the same way you would use a vinyl file:
var Item = ;var item = path: 'foo';
Create an instance of
Item. Optionally pass a default object to use. See vinyl docs for API details and additional documentation.
var item =path: 'foo.html'contents: '...';
contents properties on
item. This is done to ensure compatibility with the vinyl convention of using
contents as a Buffer, as well as the assemble convention of using
content as a string. We will eventually deprecate the
var item = path: 'foo/bar.hbs' contents: 'foo';console;//=> 'foo'
Getter/setter to resolve the name of the
engine to use for rendering.
var item = path: 'foo/bar.hbs';console;//=> '.hbs'
- assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
- templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
- verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
- vinyl: Virtual file format. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
This file was generated by verb-generate-readme, v0.2.0, on December 28, 2016.