Wondering what’s next for npm?Check out our public roadmap! »

    load-json-file
    TypeScript icon, indicating that this package has built-in type declarations

    6.2.0 • Public • Published

    load-json-file Build Status

    Read and parse a JSON file

    Strips UTF-8 BOM, uses graceful-fs, and throws more helpful JSON errors.

    Install

    $ npm install load-json-file
    

    Usage

    const loadJsonFile = require('load-json-file');
     
    (async () => {
        console.log(await loadJsonFile('foo.json'));
        //=> {foo: true}
    })();

    API

    loadJsonFile(filePath, options?)

    Returns a Promise<unknown> with the parsed JSON.

    loadJsonFile.sync(filepath, options?)

    Returns the parsed JSON.

    options

    Type: object

    beforeParse

    Type: Function

    Applies a function to the JSON string before parsing.

    reviver

    Type: Function

    Prescribes how the value originally produced by parsing is transformed, before being returned. See the JSON.parse docs for more.

    Related


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i load-json-file

    DownloadsWeekly Downloads

    26,995,634

    Version

    6.2.0

    License

    MIT

    Unpacked Size

    5.59 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar