Skip to content

validate-io/object

Repository files navigation

Object

NPM version Build Status Coverage Dependencies

Validates if a value is a JavaScript object.

Installation

$ npm install validate.io-object

For use in the browser, use browserify.

Usage

var isObject = require( 'validate.io-object' );

isObject( value )

Validates if a value is a JavaScript object.

var value = {};

var bool = isObject( value );
// returns true

Note: in this implementation, arrays and null are not considered valid objects.

Examples

console.log( isObject( {} ) );
// returns true

console.log( isObject( null ) );
// returns false

console.log( isObject( [] ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2014-2015. Athan Reines.