Git Product home page Git Product logo

json's Introduction

JSON

NPM version Build Status Coverage Status Dependencies

Validates if a value is a parseable JSON string.

Installation

$ npm install validate.io-json

For use in the browser, use browserify.

Usage

var isJSON = require( 'validate.io-json' );

isJSON( value )

Validates if a value is a parseable JSON string.

var value = '{"a":5}';

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

Notes

  • validates that the input value is a string literal. For all other inputs, the method returns false.
  • validates that a string begins with either [ or { and ends with a corresponding ] or }, respectively. Hence, the method will return false for the following strings, despite JSON.parse accepting their input:
    • '<number>'; e.g., '5'
    • '<boolean>'; e.g., 'true'
    • 'null'
  • uses JSON.parse inside a try/catch. Hence, this method cannot be optimized by the compiler during runtime. Nevertheless, using this function is better than embedding a try/catch within a larger function which could be optimized in the absence of a try/catch.

Examples

var isJSON = require( 'validate.io-json' );

console.log( isJSON( '{"a":5}' ) );
// returns true

console.log( isJSON( '{a":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. Athan Reines.

json's People

Contributors

kgryte avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.