42 lines
757 B
Markdown
42 lines
757 B
Markdown
# `lua-json`
|
|
|
|
[](https://www.npmjs.com/package/lua-json)
|
|
|
|
Convert Lua tables to and from JSON.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
yarn add lua-json
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const { format, parse } = require('lua-json')
|
|
|
|
format({ x: 1 }) // 'return { x = 1 }'
|
|
parse('return { x = 1 }') // { x: 1 }
|
|
```
|
|
|
|
## API
|
|
|
|
```ts
|
|
type Json = null | boolean | number | string | Json[] | { [_: string]: Json }
|
|
|
|
format(
|
|
value: Json,
|
|
options?: {
|
|
eol: string = '\n',
|
|
singleQuote: boolean = true,
|
|
spaces: null | number | string = 2,
|
|
}
|
|
): string
|
|
|
|
parse(value: string): Json
|
|
```
|
|
|
|
## TODO
|
|
|
|
- More formatting options à la [prettier](https://prettier.io/docs/en/options.html): `printWidth` (!), `trailingComma`, `bracketSpacing`.
|