Giter VIP home page Giter VIP logo

cson.npm's Introduction

CSON

CoffeeScript-Object-Notation Parser. Same as JSON but for CoffeeScript objects.

What is CSON?

Everyone knows JSON, it's the thing that looks like this:

{
	"abc": [
		"a",
		"b",
		"c"
	],
	"a": {
		"b": "c"
	}
}

But with the invention of CoffeeScript you can also write the same thing in CSON which looks like this:

{
	abc: [
		'a'
		'b'
		'c'
	]
	a:
		b: 'c'
}

Which is far more leniant than JSON, nicer to write and read, and won't fail if you forget a comma.

Installing

  1. Install Node.js

  2. Install CSON

     npm install cson
    

Using CSON

  • With Node.js in JavaScript

     // Include CSON
     require('coffee-script');
     CSON = require('cson');
    
     // Parse a file
     CSON.parseFile('data.cson', function(err,obj){});
    
     // Parse a string
     CSON.parse(dataStr, function(err,obj){});
    
     // Stringify an object
     CSON.stringify(data, function(err,str){});
  • With Node.js in CoffeeScript

     # Include CSON
     CSON = require 'cson'
    
     # Parse a file
     CSON.parseFile 'data.cson', (err,obj) ->
    
     # Parse a string
     CSON.parse dataStr, (err,obj) ->
    
     # Stringify an object
     CSON.stringify data, (err,str) ->
    
    

Learning

To learn more about CSON visit its wiki here

History

  • v0.2 August 10, 2011

    • Added synchronous interface thanks to clyfe - closes issue #1 and #3
  • v0.1 June 2, 2011

    • Initial commit

License

Licensed under the MIT License Copyright 2011 Benjamin Arthur Lupton

cson.npm's People

Contributors

balupton avatar

Stargazers

 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.