27 lines
795 B
JavaScript
27 lines
795 B
JavaScript
|
'use strict'
|
||
|
|
|
||
|
|
const fs = require('fs')
|
||
|
|
const parse = require('./parse')
|
||
|
|
|
||
|
|
module.exports = read
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Public function `read`.
|
||
|
|
*
|
||
|
|
* Returns a promise and asynchronously parses a JSON file read from disk. If
|
||
|
|
* there are no errors, the promise is resolved with the parsed data. If errors
|
||
|
|
* occur, the promise is rejected with the first error.
|
||
|
|
*
|
||
|
|
* @param path: Path to the JSON file.
|
||
|
|
*
|
||
|
|
* @option reviver: Transformation function, invoked depth-first.
|
||
|
|
*
|
||
|
|
* @option yieldRate: The number of data items to process per timeslice,
|
||
|
|
* default is 16384.
|
||
|
|
*
|
||
|
|
* @option Promise: The promise constructor to use, defaults to bluebird.
|
||
|
|
**/
|
||
|
|
function read (path, options) {
|
||
|
|
return parse(fs.createReadStream(path, options), Object.assign({}, options, { ndjson: false }))
|
||
|
|
}
|