vinyl-group

vinyl-group

Vinyl object that contains groups of vinyl objects created with group-array.

Install

Install with npm:

$ npm install --save vinyl-group

Usage

var VinylGroup = require('vinyl-group');

API

VinylGroup

Create an instance of VinylGroup. Pass in a group from group-array to store.

Params

• group {Object}: A group object created by passing an array of vinyl file into group-array.

Example

var files = [ ... ]; // array of vinyl files
var group = groupArray(files, 'data.tags');
var vinylGroup = new VinylGroup(group);

console.log(vinylGroup.group === group);
//=> true

console.log(vinylGroup);
//=> <VinylGroup ["foo (3)", "bar (3)"]>

About

Related projects

• group-array: Group array of objects into lists. | homepage
• gulp: The streaming build system | homepage
• vinyl: A virtual file format | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

This file was generated by verb, v0.9.0, on July 29, 2016.