package/package.json000644 000765 000024 0000002555 12471607466013041 0ustar00000000 000000 {
"name": "validate.io-function",
"version": "1.0.2",
"description": "Validates if a value is a function.",
"author": {
"name": "Athan Reines",
"email": "kgryte@gmail.com"
},
"contributors": [
{
"name": "Athan Reines",
"email": "kgryte@gmail.com"
}
],
"scripts": {
"test": "./node_modules/.bin/mocha",
"test-cov": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --dir ./reports/coverage -- -R spec",
"coveralls": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --dir ./reports/coveralls/coverage --report lcovonly -- -R spec && cat ./reports/coveralls/coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./reports/coveralls"
},
"main": "./lib",
"repository": {
"type": "git",
"url": "git://github.com/validate-io/function.git"
},
"keywords": [
"validate.io",
"validate",
"validation",
"validator",
"valid",
"function",
"is",
"isfunction"
],
"bugs": {
"url": "https://github.com/validate-io/function/issues"
},
"dependencies": {},
"devDependencies": {
"chai": "1.x.x",
"mocha": "1.x.x",
"coveralls": "^2.11.1",
"istanbul": "^0.3.0",
"jshint": "^2.5.10",
"jshint-stylish": "^1.0.0"
},
"licenses": [
{
"type": "MIT",
"url": "http://www.opensource.org/licenses/MIT"
}
]
}
package/README.md000644 000765 000024 0000005065 12471462670012025 0ustar00000000 000000 Function
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]
> Validates if a value is a function.
## Installation
``` bash
$ npm install validate.io-function
```
For use in the browser, use [browserify](https://github.com/substack/node-browserify).
## Usage
``` javascript
var isFunction = require( 'validate.io-function' );
```
#### isFunction( value )
Validates if a `value` is a `function`.
``` javascript
var value = function beep(){};
var bool = isFunction( value );
// returns true
```
## Examples
``` javascript
console.log( isFunction( function foo(){} ) );
// returns true
console.log( isFunction( {} ) );
// returns false
```
To run the example code from the top-level application directory,
``` bash
$ node ./examples/index.js
```
## Tests
### Unit
Unit tests use the [Mocha](http://mochajs.org) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
``` bash
$ make test
```
All new feature development should have corresponding unit tests to validate correct functionality.
### Test Coverage
This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
``` bash
$ make test-cov
```
Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
``` bash
$ make view-cov
```
---
## License
[MIT license](http://opensource.org/licenses/MIT).
## Copyright
Copyright © 2014. Athan Reines.
[npm-image]: http://img.shields.io/npm/v/validate.io-function.svg
[npm-url]: https://npmjs.org/package/validate.io-function
[travis-image]: http://img.shields.io/travis/validate-io/function/master.svg
[travis-url]: https://travis-ci.org/validate-io/function
[coveralls-image]: https://img.shields.io/coveralls/validate-io/function/master.svg
[coveralls-url]: https://coveralls.io/r/validate-io/function?branch=master
[dependencies-image]: http://img.shields.io/david/validate-io/function.svg
[dependencies-url]: https://david-dm.org/validate-io/function
[dev-dependencies-image]: http://img.shields.io/david/dev/validate-io/function.svg
[dev-dependencies-url]: https://david-dm.org/dev/validate-io/function
[github-issues-image]: http://img.shields.io/github/issues/validate-io/function.svg
[github-issues-url]: https://github.com/validate-io/function/issues
package/LICENSE000644 000765 000024 0000002067 12400472107011536 0ustar00000000 000000 The MIT License (MIT)
Copyright (c) 2014 Athan Reines.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.package/lib/index.js000644 000765 000024 0000001131 12471462731012745 0ustar00000000 000000 /**
*
* VALIDATE: function
*
*
* DESCRIPTION:
* - Validates if a value is a function.
*
*
* NOTES:
* [1]
*
*
* TODO:
* [1]
*
*
* LICENSE:
* MIT
*
* Copyright (c) 2014. Athan Reines.
*
*
* AUTHOR:
* Athan Reines. kgryte@gmail.com. 2014.
*
*/
'use strict';
/**
* FUNCTION: isFunction( value )
* Validates if a value is a function.
*
* @param {*} value - value to be validated
* @returns {Boolean} boolean indicating whether value is a function
*/
function isFunction( value ) {
return ( typeof value === 'function' );
} // end FUNCTION isFunction()
// EXPORTS //
module.exports = isFunction;