errno

What is errno?

The errno npm package provides a convenient way to create, manage, and interact with system-level errors in Node.js applications. It allows developers to easily look up error codes and create custom errors that integrate seamlessly with Node.js's error handling mechanisms.

What are errno's main functionalities?

Creating custom errors

This feature allows developers to create custom errors. The code sample demonstrates how to create a new custom error type called 'MyError' and then instantiate an error of this type.

const create = require('errno').create;
const MyError = create('MyError');
const err = new MyError('An error occurred');

Looking up error codes

This feature enables developers to look up error codes by their common names. The code sample shows how to access the properties of the 'errno.code' object to find information about the 'ENOENT' error code.

const errno = require('errno');
console.log(errno.code.ENOENT);

Other packages similar to errno

verror

Verror is a package that provides a way to create rich JavaScript errors. It is similar to errno in that it enhances error handling in Node.js applications, but it focuses more on providing a framework for annotating errors than on integrating with system-level errors.

error

The 'error' package offers a simple way to create custom errors in Node.js, similar to errno's functionality for creating custom errors. However, it does not provide the same level of integration with system-level error codes.

README

node-errno

Better libuv/Node.js error handling & reporting. Available in npm as errno.

• errno exposed
• Custom errors

errno exposed

Ever find yourself needing more details about Node.js errors? Me too, so node-errno contains the errno mappings direct from libuv so you can use them in your code.

By errno:

require('errno').errno[3]
// → {
//     "errno": 3,
//     "code": "EACCES",
//     "description": "permission denied"
//   }

By code:

require('errno').code.ENOTEMPTY
// → {
//     "errno": 53,
//     "code": "ENOTEMPTY",
//     "description": "directory not empty"
//   }

Make your errors more descriptive:

var errno = require('errno')

function errmsg(err) {
    var str = 'Error: '
    // if it's a libuv error then get the description from errno
    if (errno.errno[err.errno]) {
        str += errno.errno[err.errno].description
    } else {
        str += err.message
    }
    
    // if it's a `fs` error then it'll have a 'path' property
    if (err.path) {
        str += ' [' + err.path + ']'
    }
    return str
}

var fs = require('fs')

fs.readFile('thisisnotarealfile.txt', function (err, data) {
    if (err)
        return console.log(errmsg(err))
})

Use as a command line tool:

~ $ errno 53
{
  "errno": 53,
  "code": "ENOTEMPTY",
  "description": "directory not empty"
}
~ $ errno EROFS
{
  "errno": 56,
  "code": "EROFS",
  "description": "read-only file system"
}
~ $ errno foo
No such errno/code: "foo"

Supply no arguments for the full list. Error codes are processed case-insensitive.

You will need to install with npm install errno -g if you want the errno command to be available without supplying a full path to the node_modules installation.

Custom errors

Use errno.custom.createError() to create custom Error objects to throw around in your Node.js library. Create error heirachies so instanceof becomes a useful tool in tracking errors. Call-stack is correctly captured at the time you create an instance of the error object, plus a cause property will make available the original error object if you pass one in to the constructor.

var errno = require('errno')
var MyError = errno.custom.createError('MyError') // inherits from Error
var SpecificError = errno.custom.createError('SpecificError', MyError) // inherits from MyError
var OtherError = errno.custom.createError('OtherError', MyError)

// use them!
if (condition) throw new SpecificError('Eeek! Something bad happened')

if (err) return callback(new OtherError(err))

Also available is a errno.custom.FilesystemError with in-built access to errno properties:

fs.readFile('foo', function (err, data) {
  if (err) return callback(new errno.custom.FilesystemError(err))
  // do something else
})

The resulting error object passed through the callback will have the following properties: code, errno, path and message will contain a descriptive human-readable message.

Contributors

• bahamas10 (Dave Eddy) - Added CLI

Copyright & Licence

Copyright (c) 2012 Rod Vagg (@rvagg)

Made available under the MIT licence:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.