is-view

is-view

Returns true if a value is an object and appears to be a valid Templates view object.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save is-view

Usage

const isView = require('is-view');

Returns true when the given value has properties expected on a templates (or assemble) view. Views are also valid vinyl objects:

console.log(isView({ path: 'foo' }));                    
console.log(isView({ path: '' }));                    
//=> true
console.log(isView({ _isVinyl: true }));                 
//=> true
console.log(isView({ isView: true }));                   
//=> true
console.log(isView({ content: '' }));                    
//=> true
console.log(isView({ content: null }));                  
//=> true
console.log(isView({ contents: null }));                 
//=> true
console.log(isView({ contents: new Buffer('') }));       
//=> true
console.log(isView({ contents: { pipe: () => {} } }));   
//=> true

About

Contributing

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

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

Building docs

(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

Related projects

You might also be interested in these projects:

• 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
• vinyl: Virtual file format. | homepage

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on March 05, 2018.