validate.io-buffer

!NPM versionnpm-imagenpm-url !Build Statusbuild-imagebuild-url !Coverage Statuscoverage-imagecoverage-url !Dependenciesdependencies-imagedependencies-url

Validates if a value is a Buffernode-buffer object.

Installation

$ npm install validate.io-buffer

Usage

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

isBuffer( value )

Validates if a value is a Buffernode-buffer object.

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

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

Notes

• Validates both Node.jsnode-buffer and browserbrowser-buffer (polyfill) Buffer objects.

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

This repository uses tapetape for unit tests. 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 Istanbulistanbul 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

Browser Support

This repository uses Testlingtestling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

$ make test-browsers

To view the tests in a local web browser,

$ make view-browser-tests

---

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.