https://github.com/zkochan/load-json5-file

Read and parse a JSON5 file
https://github.com/zkochan/load-json5-file

Last synced: 10 days ago
JSON representation

Read and parse a JSON5 file

• Host: GitHub
• URL: https://github.com/zkochan/load-json5-file
• Owner: zkochan
• License: mit
• Created: 2017-04-16T16:55:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-06T20:09:25.000Z (over 7 years ago)
• Last Synced: 2024-11-14T21:38:45.982Z (about 1 month ago)
• Language: JavaScript
• Size: 22.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# load-json5-file

> Read and parse a JSON5 file

[![npm version](https://img.shields.io/npm/v/load-json5-file.svg)](https://www.npmjs.com/package/load-json5-file) [![Build Status](https://img.shields.io/travis/zkochan/load-json5-file/master.svg)](https://travis-ci.org/zkochan/load-json5-file)

[Strips UTF-8 BOM](https://github.com/sindresorhus/strip-bom) and uses [`graceful-fs`](https://github.com/isaacs/node-graceful-fs).

## Installation

```sh

npm i -S load-json5-file

```

## Usage

```js

'use strict'

const loadJson5File = require('load-json5-file')

const path = require('path')

const fixture = path.join(__dirname, 'countries.json5')

const countries = loadJson5File.sync(fixture)

console.log(countries)

//> [ 'Ukraine', 'Hungary', 'Slovakia' ]

```

## API

### `loadJson5File(filepath)`

Returns a promise for the parsed JSON5.

### `loadJson5File.sync(filepath)`

Returns the parsed JSON5.

## Related

- [write-json5-file](https://github.com/zkochan/write-json5-file) - Stringify and write JSON5 to a file atomically

- [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file

- [json5](https://github.com/json5/json5) - JSON for the ES5 era

## License

[MIT](./LICENSE) © [Zoltan Kochan](https://www.kochan.io)