@jfabello/system-errors v3.0.1

Node.js Custom System Error Classes

A Node.js module that maps common POSIX system error codes into custom system error classes.

This module helps developers handle POSIX system errors with meaningful and descriptive error messages, enhancing the debugging and error-handling processes.

Table of Contents

• Installation
• Usage
  • Creating Errors Based on System Error Codes
  • Custom System Error Classes
• POSIX System Errors Mapped
• Contributing
• License

Installation

You can install this module via npm:

npm install @jfabello/system-errors

Usage

After installation, import the module and use the createErrorFromSystemErrorCode() method or the predefined custom system error classes in your application:

import { errors as systemErrors } from "@jfabello/system-errors";

try {
	// Some code that might throw a POSIX system error
} catch (error) {
	if ("code" in error) {
		throw systemErrors.createErrorFromSystemErrorCode(error.code);
	} else {
		throw new systemErrors.errors.ERROR_UNKNOWN();
	}
}

Creating Errors Based on System Error Codes

This module provides a createErrorFromSystemErrorCode() method, which dynamically creates a custom system error object based on the POSIX system error code:

import { errors as systemErrors } from "@jfabello/system-errors";

const error = systemErrors.createErrorFromSystemErrorCode("EACCES");
console.log(error.message); // Output: The operation does not have enough permissions.

This method takes a string as its only argument. It returns an instance of the custom system error class that corresponds to the POSIX system error code passed in the string, or an instance of ERROR_UNKNOWN if the string can't be matched to a particular POSIX system error code.

Custom System Error Classes

The module also provides predefined custom system error classes that can be used directly in your code. These classes can be accessed via the errors object. Each class represents a specific POSIX system error and has a descriptive message associated with it:

import { errors as systemErrors } from "@jfabello/system-errors";

const error = new systemErrors.errors.ERROR_NO_ACCESS();
console.log(error.message); // Output: The operation does not have enough permissions.

POSIX System Errors Mapped

Contributing

Unfortunately, we are not able to accept contributions at this time.

If you find a bug in the code, please open an issue.

Thank you for your understanding.

License

This project is licensed under the MIT License. See the LICENSE file for details.