# is-boilerplate

> Returns true if an object is a Boilerplate instance.

Latest version **0.1.1** (published 2016-05-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-boilerplate
pnpm add is-boilerplate
yarn add is-boilerplate
bun add is-boilerplate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-05-11 |
| First published | 2016-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | boilerplate, boilerplatefriendly, scaffold |

## Links

- npm: https://www.npmjs.com/package/is-boilerplate
- Repository: https://github.com/boilerplate/is-boilerplate
- Issues: https://github.com/boilerplate/is-boilerplate/issues
- npm.io page: https://npm.io/package/is-boilerplate

## Dependencies (1)

- [is-plain-object](https://npm.io/package/is-plain-object.md) ^2.0.1

## Recent versions

- 0.1.1 (latest) — 2016-05-11
- 0.1.0 — 2016-05-11

## README

# is-boilerplate [![NPM version](https://img.shields.io/npm/v/is-boilerplate.svg?style=flat)](https://www.npmjs.com/package/is-boilerplate) [![NPM downloads](https://img.shields.io/npm/dm/is-boilerplate.svg?style=flat)](https://npmjs.org/package/is-boilerplate) [![Build Status](https://img.shields.io/travis/boilerplate/is-boilerplate.svg?style=flat)](https://travis-ci.org/boilerplate/is-boilerplate)

Returns true if an object is a Boilerplate instance.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install is-boilerplate --save
```

## Usage

```js
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](https://www.npmjs.com/package/boilerplate): Tools and conventions for authoring and publishing boilerplates that can be generated by any build… [more](https://www.npmjs.com/package/boilerplate) | [homepage](http://boilerplates.io)
* [scaffold](https://www.npmjs.com/package/scaffold): Conventions and API for creating declarative configuration objects for project scaffolds - similar in format… [more](https://www.npmjs.com/package/scaffold) | [homepage](https://github.com/jonschlinkert/scaffold)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/boilerplate/is-boilerplate/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/boilerplate/is-boilerplate/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 11, 2016._

---
_Source: https://npm.io/package/is-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._