Neck Protection Mandate

    parse-json
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/parse-json package

    4.0.0 • Public • Published

    parse-json Build Status

    Parse JSON with more helpful errors

    Install

    $ npm install parse-json
    

    Usage

    const parseJson = require('parse-json');
    const json = '{\n\t"foo": true,\n}';
    
    
    JSON.parse(json);
    /*
    undefined:3
    }
    ^
    SyntaxError: Unexpected token }
    */
    
    
    parseJson(json);
    /*
    JSONError: Trailing comma in object at 3:1
    }
    ^
    */
    
    
    parseJson(json, 'foo.json');
    /*
    JSONError: Trailing comma in object in foo.json:3:1
    }
    ^
    */
    
    
    // You can also add the filename at a later point
    try {
    	parseJson(json);
    } catch (err) {
    	err.fileName = 'foo.json';
    	throw err;
    }
    /*
    JSONError: Trailing comma in object in foo.json:3:1
    }
    ^
    */

    API

    parseJson(input, [reviver], [filename])

    input

    Type: string

    reviver

    Type: Function

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

    filename

    Type: string

    Filename displayed in the error message.

    License

    MIT © Sindre Sorhus

    Install

    npm i parse-json@4.0.0

    Version

    4.0.0

    License

    MIT

    Last publish

    Collaborators

    • sindresorhus