# json-lexer

> lexing json

Latest version **1.2.0** (published 2022-04-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install json-lexer
pnpm add json-lexer
yarn add json-lexer
bun add json-lexer
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2022-04-26 |
| First published | 2016-07-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Finn Pauls |
| Maintainers | finnpauls |
| Keywords | tokens, tokenize, whitespace, json, parse, parser |

## Links

- npm: https://www.npmjs.com/package/json-lexer
- Repository: https://github.com/finnp/json-lexer
- Homepage: https://github.com/finnp/json-lexer#readme
- Issues: https://github.com/finnp/json-lexer/issues
- npm.io page: https://npm.io/package/json-lexer

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.0 (latest) — 2022-04-26
- 1.1.1 — 2016-07-30
- 1.1.0 — 2016-07-30
- 1.0.0 — 2016-07-30

## README

# json-lexer

[![Build Status](https://travis-ci.org/finnp/json-lexer.svg?branch=master)](https://travis-ci.org/finnp/json-lexer)
[![Coverage Status](https://coveralls.io/repos/finnp/json-lexer/badge.svg?branch=master&service=github)](https://coveralls.io/github/finnp/json-lexer?branch=master)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![NPM](https://nodei.co/npm/json-lexer.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/json-lexer/)

This is a JSON lexer based on the implementation in [json3](https://github.com/bestiejs/json3).
It can split a JSON String into a list of annotated tokens. It will list whitespace
as well, so it can used in-place editing of JSON documents.

Note that this doesn't check the validity of your JSON, so it will tokenize something
like `"token"}:` happily.

```js
var lexer = require('json-lexer')
lexer('{"hello": 1.0}')
// results in
[ { type: 'punctuator', value: '{', raw: '{' },
  { type: 'string', value: 'hello', raw: '"hello"' },
  { type: 'punctuator', value: ':', raw: ':' },
  { type: 'whitespace', value: ' ', raw: ' ' },
  { type: 'number', value: 1, raw: '1.0' },
  { type: 'punctuator', value: '}', raw: '}' } ]
```

## types

### whitespace
Allowed white space between the actual relevant tokens.

### punctuator
The characters surrounding your data: `{`, `}`, `[`, `]`, `:` and `,`

### string
A JSON string `"hi"`, not that the value will be the parsed String without `"`

### number
A JSON number, like `1`, `-1` or `1e1000`. The value will be the parsed number.

### literal
One of the allowed literals `true`, `false` and `null`. The value will be the
specific JS literal.

---
_Source: https://npm.io/package/json-lexer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._