Package Exports
- read-json-sync
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (read-json-sync) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
read-json-sync
A Node.js module to read and parse a JSON file synchronously
const readJsonSync = require('read-json-sync');
readJsonSync('package.json'); //=> {name: 'read-json-sync', version: '1.0.0', ...}
Node.js built-in require
and import
can do almost the same thing, but this module doesn't cache results.
Installation
npm install read-json-sync
API
const readJsonSync = require('read-json-sync');
readJsonSync(path [, options])
path: string
Buffer
URL
(JSON filename) or integer
(file descriptor)
options: Object
string
(fs.readFile
options or an encoding of the file)
Return: any
(parsed JSON data)
It automatically ignores the leading byte order mark.
// with-bom.json: '\uFEFF{"a": 1}'
JSON.parse('\uFEFF{"a": 1}'); // throws a SyntaxError
readJsonSync('with-bom.json'); //=> {a: 1}
License
ISC License © 2017 - 2018 Shinnosuke Watanabe