validate.io-buffer

buffer

Validates if a value is a Buffer object.

Installation

$ npm install validate.io-buffer

For use in the browser, use browserify.

Note: while the module does not have any dependencies, the module is really only useful in the browser when combined with a browserified Buffer module.

Usage

var isBuffer = require( 'validate.io-buffer' );

isBuffer( value )

Validates if a value is a Buffer object.

var value = new Buffer( [1,2,3,4] );

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

Examples

var isBuffer = require( 'validate.io-buffer' );

console.log( isBuffer( new Buffer( [1,2,3,4] ) ) );
// returns true

console.log( isBuffer( new Buffer( 'beep' ) ) );
// returns true

console.log( isBuffer( [] ) );
// 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 © 2015. Athan Reines.