https://github.com/eomm/fastify-json5

This plugin enable your server to process JSON5 payloads
https://github.com/eomm/fastify-json5

application-json5 fastify fastify-plugin json5

Last synced: about 2 months ago
JSON representation

This plugin enable your server to process JSON5 payloads

• Host: GitHub
• URL: https://github.com/eomm/fastify-json5
• Owner: Eomm
• License: mit
• Created: 2022-10-14T06:48:30.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T19:00:43.000Z (3 months ago)
• Last Synced: 2024-10-12T07:46:20.133Z (2 months ago)
• Topics: application-json5, fastify, fastify-plugin, json5
• Language: JavaScript
• Homepage:
• Size: 18.6 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fastify-json5

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![ci](https://github.com/Eomm/fastify-json5/actions/workflows/ci.yml/badge.svg)](https://github.com/Eomm/fastify-json5/actions/workflows/ci.yml)

This plugin enable your server to process JSON5 payloads.  

It adds a new `application/json5` content type parser to Fastify and

decorate the `reply` object with a `sendJSON5()` utility.

## Install

```

npm install fastify-json5

```

### Compatibility

| Plugin version | Fastify version |

| -------------- |:---------------:|

| `^1.0.0` | `^4.0.0` |

## Usage

```js

const fastify = require('fastify')

const fastifyJson5 = require('fastify-json5')

const app = fastify()

app.register(fastifyJson5, { 

  reviver: (key, value) => value // optionally pass a reviver function

})

app.post('/', (req, reply) => {

  console.log(req.body)

  reply.sendJSON5(req.body, {

    replacer, // optionally

    space,    // optionally

    quote     // optionally

  })

})

app.inject({

  method: 'POST',

  url: '/',

  headers: { 'content-type': 'application/json5' },

  payload: `{

    // comments

    unquoted: 'and you can quote me on that',

    singleQuotes: 'I can use "double quotes" here',

    lineBreaks: "Look, Mom! \

  No \\n's!",

    hexadecimal: 0xdecaf,

    leadingDecimalPoint: .8675309, andTrailing: 8675309.,

    positiveSign: +1,

    negativeSign: -9,

    trailingComma: 'in objects', andIn: ['arrays',],

    "backwardsCompatible": "with JSON",

  }`

})

```

## Options

This plugin uses the [`json5`](https://github.com/json5/json5) under the hood.

So you can provide the same options of the `json5` module.

When you register the plugin you can pass the [`JSON.parse`](https://github.com/json5/json5#parameters) options:

- `reviver`

When you call the `reply.sendJSON5()` you can pass the [`JSON.stringify`](https://github.com/json5/json5#parameters-1):

- `replacer`

- `space`

- `quote`

## Security

By default, the `json5` module behaves like the `JSON.parse` and `JSON.stringify` methods.

So [it parse and add to the prototype](https://github.com/json5/json5/commit/4a8c4568fe6bf85daf6f473aaa50007c43f74d6e) the `__proto__` property.

This module implements a security check to avoid the `__proto__` property to be added to the prototype. In this case the plugin will throw an http 400 error.

## License

Copyright [Manuel Spigolon](https://github.com/Eomm), Licensed under [MIT](./LICENSE).