Skip to content

About

comments support for json in node.js

Resources

Stars

20 stars

Watchers

1 watching

Forks

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSON Comments NPM version

Make your json config support comments.

Installation

$ npm install json-comments

Syntax:

// require `json-comments` in your main module only once
require('json-comments');

Examples:

config.json

{
  // this is host
  "host" : "localhost",

  "port" : 3000, //port

  "url" : "https://github.com/numbcoder", /* url */

  /*
  * comments support for json
  */
  "username": "abc"
}

app.js

require('json-comments');
var config = require('./config');

console.log(config);
// ...

Parse JSON string

var JSONC = require('json-comments');
var fs = require('fs');

var content = fs.readFileSync('./config.json', 'utf8');
// parse JSON String
var config = JSONC.parse(content);

console.log(config);

Minify the JSON string

var JSONC = require('json-comments');
var fs = require('fs');

var content = fs.readFileSync('./config.json', 'utf8');

// remove comments and spaces from JSON String
var JsonStr = JSONC.minify(content);

License

MIT

Bitdeli Badge

About

comments support for json in node.js

Resources

Stars

20 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages