Natural Pleistocene Monsters

    @stdlib/error-to-json
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    toJSON

    NPM version Build Status Coverage Status

    Return a JSON representation of an error object.

    Installation

    npm install @stdlib/error-to-json

    Usage

    var toJSON = require( '@stdlib/error-to-json' );

    toJSON( error )

    Returns a JSON representation of an error object.

    var err = new Error( 'beep' );
    
    var json = toJSON( err );
    /* returns
        {
            'type': 'Error',
            'name': 'Error', // if present
            'message': 'beep',
            'stack': '...' // if present
        }
    */

    The JSON object is guaranteed to have the following properties:

    • type: error type.
    • message: error message.

    The only standardized cross-platform property is message. Depending on the platform, the following properties may be present:

    • name: error name.
    • stack: stack trace.
    • code: error code (Node.js system errors).
    • errno: error code string (Node.js system errors).
    • syscall: string representing the failed system call (Node.js system errors).

    The function also serializes all enumerable properties.

    var err = new Error( 'beep' );
    err.a = 'b';
    err.c = { 'd': 'e' };
    
    var json = toJSON( err );
    /* returns
        {
            'type': 'Error',
            'name': 'Error', // if present
            'message': 'beep',
            'stack': '...', // if present
            'a': 'b',
            'c': {
                'd': 'e'
            }
        }
    */

    Notes

    • Supported built-in error types:

    • The implementation supports custom error types and sets the type field to the closest built-in error type.

      function CustomError( msg ) {
          this.name = 'CustomError';
          this.message = msg || '';
          this.stack = ( new TypeError() ).stack;
          return this;
      }
      CustomError.prototype = Object.create( TypeError.prototype );
      CustomError.prototype.constructor = CustomError;
      
      var err = new CustomError( 'boop' );
      
      var json = toJSON( err );
      /*
          {
              'type': 'TypeError',
              'name': 'CustomError',
              'message': 'boop',
              'stack': '...'
          }
      */

    Examples

    var toJSON = require( '@stdlib/error-to-json' );
    
    var err = new Error( 'beep' );
    var out = toJSON( err );
    /* returns
        {
            'type': 'Error',
            'name': 'Error',
            'message': 'beep',
            'stack': '...'
        }
    */
    
    err = new TypeError( 'invalid type' );
    out = toJSON( err );
    /* returns
        {
            'type': 'TypeError',
            'name': 'TypeError',
            'message': 'invalid type',
            'stack': '...'
        }
    */
    
    err = new SyntaxError( 'bad syntax' );
    out = toJSON( err );
    /* returns
        {
            'type': 'SyntaxError',
            'name': 'SyntaxError',
            'message': 'bad syntax',
            'stack': '...'
        }
    */
    
    err = new ReferenceError( 'unknown variable' );
    out = toJSON( err );
    /* returns
        {
            'type': 'ReferenceError',
            'name': 'ReferenceError',
            'message': 'unknown variable',
            'stack': '...'
        }
    */
    
    err = new URIError( 'bad URI' );
    out = toJSON( err );
    /* returns
        {
            'type': 'URIError',
            'name': 'URIError',
            'message': 'bad URI',
            'stack': '...'
        }
    */
    
    err = new RangeError( 'value out-of-range' );
    out = toJSON( err );
    /* returns
        {
            'type': 'RangeError',
            'name': 'RangeError',
            'message': 'value out-of-range',
            'stack': '...'
        }
    */
    
    err = new EvalError( 'eval error' );
    out = toJSON( err );
    /* returns
        {
            'type': 'EvalError',
            'name': 'EvalError',
            'message': 'eval error',
            'stack': '...'
        }
    */

    See Also


    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/error-to-json

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    313

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    45.4 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser