ceson

CESON: Commented ECMAScript Object Notation

Yet another JSON derivative, aimed to be easy to use for humans as well as for low-level tools.

✨ 📖 ✨ spec ✨ 📖 ✨ example ✨ 📖 ✨

Main features:

• True subset of ECMAScript.
• Parser-friendly (block and line) comments.
• Comma after last value in data containers. (optional)
• Guaranteed support for UTF-8 BOM.

Related projects:

• JSONv5: A lot more flexible, and thus a lot harder to safely handle with low-level tools like sed.
• strip-json-comments

API

For examples, see test/felidae.js.

.stringify(data)

Return a CESON representation of data as a string.

.parse(ceson[, syntaxErrorSymbol])

Return the data represented by the string ceson if it can be parsed. If it cannot be parsed because of a syntax error, behavior depends on syntaxErrorSymbol, which can be:

• omitted: Return undefined for easy distinction from valid CESON values like null, false, zero and the empty string.
• any string or false-y value: Return that value.
• true: Throw an error.
• a function: Experimental. Call it with arguments (err, input) and return its result. The input argument might differ from ceson.
• any other value: Fail in unreliable, mysterious ways.

Errors that cannot be verified to be syntax errors are re-thrown. (Examples might include "cannot allocate buffer" or "too much recursion".)

.parseFile(filename, callback)

Try to parse CESON text file filename, then report to callback.

.parseFile(fileOpts, callback)

(no description yet)

.parseCallbackData(readErr, data, callback)

(no description yet)

License

ISC