is-boilerplate

is-boilerplate

Returns true if an object is a Boilerplate instance.

Install

Install with npm:

$ npm install is-boilerplate --save

Usage

var isBoilerplate = require('is-boilerplate');
var Boilerplate = require('boilerplate');

// returns false if the value is not a Boilerplate
isBoilerplate('a')// false
isBoilerplate({})// false
isBoilerplate({ files: [] })// false

// returns true if the value is a Boilerplate instance
var boilerplate = new Boilerplate({ src: ['*.js'] });
isBoilerplate(boilerplate) // true

Related projects

You might also be interested in these projects:

• boilerplate: Tools and conventions for authoring and publishing boilerplates that can be generated by any build… more | homepage
• scaffold: Conventions and API for creating declarative configuration objects for project scaffolds - similar in format… more | homepage

Contributing

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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 11, 2016.