README

Binary String

Validates if a value is a binary string.

Installation

$ npm install validate.io-binary-string

For use in the browser, use browserify.

Usage

var isBinaryString = require( 'validate.io-binary-string' );

isBinaryString( value )

Validates if a value is a binary string; i.e., a character sequence of 1's and 0's.

var value = '1000101';

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

Examples

var isBinaryString = require( 'validate.io-binary-string' );

console.log( isBinaryString( '1' ) );
// returns true

console.log( isBinaryString( '0' ) );
// returns true

console.log( isBinaryString( '101010101001' ) );
// returns true

console.log( isBinaryString( '' ) );
// returns false

console.log( isBinaryString( 'beep' ) );
// returns false

console.log( isBinaryString( null ) );
// 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.

validate.io-binary-string

Usage no npm install needed!