validate.io-timestamp

Validates if a value is a timestamp.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
validate.io-timestamp
401.0.29 years ago10 years agoMinified + gzip package size for validate.io-timestamp in KB

Readme

Timestamp
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Validates if a value is a timestamp.

Installation

$ npm install validate.io-timestamp

For use in the browser, use browserify.

Usage

var isTimestamp = require( 'validate.io-timestamp' );

isTimestamp( value )

Validates if a value is a timestamp.
var value = Date.now();

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

A valid timestamp may be in either milliseconds or seconds.

Notes

The value to be validated should be numeric. For any other type, the method returns false.

Examples

var isTimestamp = require( 'validate.io-timestamp' );

console.log( isTimestamp( Date.now() ) );
// returns true

var secs = Math.round( Date.now()/1000 );
console.log( isTimestamp( secs ) );
// returns true

console.log( isTimestamp( 123456 ) );
// returns false

console.log( isTimestamp( new Date() ) );
// 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. Athan Reines.