Skip to content

Update readme with use case for the module interface #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme with use case for the module interface #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,17 @@ jsonlint will either report a syntax error with details or pretty print the sour

## Module interface

I'm not sure why you wouldn't use the built in `JSON.parse` but you can use jsonlint from a CommonJS module:
You can use jsonlint from a CommonJS module:

var jsonlint = require("jsonlint");

jsonlint.parse('{"creative?": false}');

It returns the parsed object or throws an `Error`.

While the same can be accomplished with JSON.parse, jsonlint will provide error
friendlier error messages.

## Vim Plugins

* [Syntastic](http://www.vim.org/scripts/script.php?script_id=2736)
Expand Down