validate.io-string-primitive

Validates if a value is a string primitive.


Keywords
validate.io, validate, validation, validator, valid, string, primitive, is, isstring, isprimitive
License
MIT
Install
npm install validate.io-string-primitive@1.0.1

Documentation

String Primitive

NPM version Build Status Coverage Status Dependencies

Validates if a value is a string primitive.

Installation

$ npm install validate.io-string-primitive

For use in the browser, use browserify.

Usage

var isString = require( 'validate.io-string-primitive' );

isString( value )

Validates if a value is a string primitive.

var value = 'beep';

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

Examples

var isString = require( 'validate.io-string-primitive' );

console.log( isString( 'beep' ) );
// returns true

console.log( isString( new String( 'beep' ) ) );
// returns false

console.log( isString( 5 ) );
// 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-2016. Athan Reines.