.config/coc/extensions/node_modules/coc-prettier/node_modules/json-parse-better-errors/README.md

   1 # json-parse-better-errors [![npm version](https://img.shields.io/npm/v/json-parse-better-errors.svg)](https://npm.im/json-parse-better-errors) [![license](https://img.shields.io/npm/l/json-parse-better-errors.svg)](https://npm.im/json-parse-better-errors) [![Travis](https://img.shields.io/travis/zkat/json-parse-better-errors.svg)](https://travis-ci.org/zkat/json-parse-better-errors) [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/zkat/json-parse-better-errors?svg=true)](https://ci.appveyor.com/project/zkat/json-parse-better-errors) [![Coverage Status](https://coveralls.io/repos/github/zkat/json-parse-better-errors/badge.svg?branch=latest)](https://coveralls.io/github/zkat/json-parse-better-errors?branch=latest)
   2
   3 [`json-parse-better-errors`](https://github.com/zkat/json-parse-better-errors) is a Node.js library for
   4 getting nicer errors out of `JSON.parse()`, including context and position of the parse errors.
   5
   6 ## Install
   7
   8 `$ npm install --save json-parse-better-errors`
   9
  10 ## Table of Contents
  11
  12 * [Example](#example)
  13 * [Features](#features)
  14 * [Contributing](#contributing)
  15 * [API](#api)
  16   * [`parse`](#parse)
  17
  18 ### Example
  19
  20 ```javascript
  21 const parseJson = require('json-parse-better-errors')
  22
  23 parseJson('"foo"')
  24 parseJson('garbage') // more useful error message
  25 ```
  26
  27 ### Features
  28
  29 * Like JSON.parse, but the errors are better.
  30
  31 ### Contributing
  32
  33 The npm team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! The [Contributor Guide](CONTRIBUTING.md) has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.
  34
  35 All participants and maintainers in this project are expected to follow [Code of Conduct](CODE_OF_CONDUCT.md), and just generally be excellent to each other.
  36
  37 Please refer to the [Changelog](CHANGELOG.md) for project history details, too.
  38
  39 Happy hacking!
  40
  41 ### API
  42
  43 #### <a name="parse"></a> `> parse(txt, ?reviver, ?context=20)`
  44
  45 Works just like `JSON.parse`, but will include a bit more information when an
  46 error happens.