Utility for getting an assemble view from a collection object.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install with npm:
$ npm install --save get-view
Should work with any collection of vinyl files.
const getView = require('get-view');
templates example
Given the following setup code, all of the below examples would return a view from the app.views.pages collection:
const templates = require('templates');
app = templates();
app.create('page');
app.page('foo', {content: 'this is foo'});
app.page('bar.md', {content: 'this is bar'});
app.page('a/b/c/baz.md', {content: 'this is baz', base: 'a'});
app.page('test/fixtures/templates/a.tmpl');
Get a view by customizing the lookup key with a function:
const view = getView(app.views.pages, function(view) {
return view.stem === 'foo.md';
});
//=> <View "foo" <Buffer 74 68 69 73 20 69>>
Get a view by view.path
const view = getView(app.views.pages, 'a/b/c/baz.md');
//=> <View "b/c/baz.md" <Buffer 74 68 69 73>>
Get a view by view.basename
const view = getView(app.views.pages, 'baz.md');
//=> <View "b/c/baz.md" <Buffer 74 68 69 73>>
Get a view by view.filename
const view = getView(app.views.pages, 'baz');
//=> <View "b/c/baz.md" <Buffer 74 68 69 73>>
Get a view by view.relative
const view = getView(app.views.pages, 'b/c/baz.md');
//=> <View "b/c/baz.md" <Buffer 74 68 69 73>>
Breaking changes
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
name matches any of the path properties on a vinyl… more | homepageJon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on March 18, 2018.