@openinf/util-errors

Essential utility errors inspired by Node.js core error codes

The high-level goal of @openinf/util-errors is to serve as a Node.js package containing essential utility error classes that take the form of those found and used in Node.js core. We are constantly working to improve this repository, so please feel free to contribute if you notice any omissions or errors.

Thanks!

Supported Node.js Environments

• v4：Argon (Ar)
• v6：Boron (B)
• v8：Carbon (C)
• v10：Dubnium (Db)
• v12：Erbium (Er)
• v14：Fermium (Fm)
• v16：Gallium (Ga)
• v18：Hydrogen (H)

---

Table of Contents

• Installation
• Usage
• API
• Contributing
• License

---

Installation

@openinf/util-errors runs on supported versions of Node.js and is available via npm, pnpm, or yarn.

Using the npm CLI

^{See the official documentation for this command for more information.}

npm i @openinf/util-errors

Using the pnpm CLI

^{See the official documentation for this command for more information.}

pnpm add @openinf/util-errors

Using the Yarn 1 CLI (Classic)

^{See the official documentation for this command for more information.}

yarn add @openinf/util-errors

Usage

To get started using the error classes provided by @openinf/util-errors, all that needs to be done is either import/require (depending on the module format) the default export of the module or destructure the individual named error classes exported.

import { hasOwn } from '@openinf/util-object';
import { MissingOptionError } from '@openinf/util-errors';
import infLog from '@openinf/inf-log';

function getLogger(logger, opts) {
  if (!hasOwn(opts, 'scope')) {
    throw new MissingOptionError('scope');
  }

  return new logger(opts);
}

const log = getLogger(infLog, infLog.defaultOpts);

log.info('Hello, World!');

Note: The example above does not demonstrate how to properly handle this error once thrown and would likely result in an uncaught exception.

Note: If you are in an environment where the CommonJS module loader (require()) is available, destructuring the individual error classes works just as well.

API

InvalidArgValueError

Thrown in case an invalid or unsupported value was passed for a given argument.

InvalidArgTypeError

Thrown in case an argument of the wrong type was passed for a given argument.

InvalidPropertyValueError

Thrown in case an invalid or unsupported value of an object property.

InvalidPropertyTypeError

Thrown in case an invalid or unsupported value type for an object property.

InvalidReturnPropertyValueError

Thrown in case a function does not provide a valid value for one of its returned object properties on execution.

InvalidReturnPropertyTypeError

Thrown in case a function does not provide an expected value type for one of its returned object properties on execution.

InvalidReturnValueError

Thrown in case a function does not return an expected valid value on execution.

InvalidReturnTypeError

Thrown in case a function does not return an expected value type on execution, such as when a function is expected to return a promise.

InvalidArgsNumberError

Thrown in case the number of arguments passed to a function is invalid.

MissingOptionError

For APIs that accept options objects, some options might be mandatory. This error is thrown if a required option is missing.

MissingArgsError

Thrown in case a required argument of an API was not passed.

This is only used for strict compliance with the API specification (which in some cases may accept func(undefined) but not func()). In most native Node.js APIs, func(undefined) and func() are treated identically, and the ERR_INVALID_ARG_TYPE error code may be used instead.

UnhandledErrorError

Thrown in case an unhandled error occurred (for instance, when an 'error' event is emitted by an EventEmitter without an 'error' handler registered).

InvalidArgValueError

Thrown in case an invalid or unsupported value was passed for a given argument.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_INVALID_ARG_VALUE

new InvalidArgValueError(argName, value, reason)

Param	Type	Default	Description
argName	string		The argument name.
value	unknown		The actual invalid argument value.
reason	string	"is invalid"	The reason for invalidity.

InvalidArgTypeError

Thrown in case an argument of the wrong type was passed for a given argument.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_INVALID_ARG_TYPE

new InvalidArgTypeError(argName, expected, value)

Param	Type	Description
argName	string	The name of the argument of invalid type.
expected	Array<string> | string	The argument type(s) expected.
value	unknown	The actual argument value of invalid type.

InvalidPropertyValueError

Thrown in case an invalid or unsupported value of an object property.

Kind: global class

new InvalidPropertyValueError(objName, propName, value, reason)

Param	Type	Default	Description
objName	string		The name of the object in question.
propName	string		The property name assigned invalid value.
value	unknown		The actual invalid property value assigned.
reason	string	"is invalid"	The reason for invalidity.

InvalidPropertyTypeError

Thrown in case an invalid or unsupported value type for an object property.

Kind: global class

new InvalidPropertyTypeError(objName, propName, expected, value)

Param	Type	Description
objName	string	The name of the object in question.
propName	string	The property name assigned value of invalid type.
expected	Array<string> | string	The property type(s) expected.
value	unknown	The actual property value of invalid type assigned.

InvalidReturnPropertyValueError

Thrown in case a function does not provide a valid value for one of its returned object properties on execution.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_INVALID_RETURN_PROPERTY

new InvalidReturnPropertyValueError(funcName, propName, value, reason)

Param	Type	Default	Description
funcName	string		The name of the function returning the invalidity.
propName	string		The property name assigned the invalid value.
value	unknown		The actual invalid property value assigned.
reason	string	"is invalid"	The reason for invalidity.

InvalidReturnPropertyTypeError

Thrown in case a function does not provide an expected value type for one of its returned object properties on execution.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_INVALID_RETURN_PROPERTY_VALUE

new InvalidReturnPropertyTypeError(funcName, propName, expected, value)

Param	Type	Description
funcName	string	The name of the function returning the invalidity.
propName	string	The property name assigned value of invalid type.
expected	Array<string> | string	The property type(s) expected.
value	unknown	The actual property value of invalid type assigned.

InvalidReturnValueError

Thrown in case a function does not return an expected valid value on execution.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_INVALID_RETURN_VALUE

new InvalidReturnValueError(funcName, value, reason)

Param	Type	Description
funcName	string	The name of the function returning the invalidity.
value	unknown	The actual invalid value returned.
reason	string	The reason for invalidity.

InvalidReturnTypeError

Thrown in case a function does not return an expected value type on execution, such as when a function is expected to return a promise.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_INVALID_RETURN_VALUE

new InvalidReturnTypeError(funcName, expected, value)

Param	Type	Description
funcName	string	The name of the function returning the invalidity.
expected	Array<string> | string	The return type(s) expected.
value	unknown	The actual value of invalid type returned.

InvalidArgsNumberError

Thrown in case the number of arguments passed to a function is invalid.

Kind: global class

new InvalidArgsNumberError(funcName, expected, value)

Param	Type	Description
funcName	string	The name of the function in question.
expected	number	The number of arguments expected to be passed.
value	number	The actual number of arguments passed.

MissingOptionError

For APIs that accept options objects, some options might be mandatory. This error is thrown if a required option is missing.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_MISSING_OPTION

new MissingOptionError(optName)

Param	Type	Description
optName	string	The name of the missing option.

MissingArgsError

Thrown in case a required argument of an API was not passed.

This is only used for strict compliance with the API specification (which in some cases may accept func(undefined) but not func()). In most native Node.js APIs, func(undefined) and func() are treated identically, and the ERR_INVALID_ARG_TYPE error code may be used instead.

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_MISSING_ARGS

new MissingArgsError(...args)

Param	Type	Description
...args	Array<string>	The names of the missing arguments.

UnhandledErrorError

Thrown in case an unhandled error occurred (for instance, when an 'error' event is emitted by an EventEmitter without an 'error' handler registered).

Kind: global class
See: https://nodejs.org/api/errors.html#ERR_UNHANDLED_ERROR

---

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If for whatever reason you spot something to fix but cannot patch it yourself, please open an issue.

License

This project is licensed under either of

• Apache License, Version 2.0
• MIT license

at your option.

The SPDX license identifier for this project is MIT OR Apache-2.0.

---

Show Your Support

If you like the project (or want to bookmark it) —
— give it a star ⭐️ — it will greatly encourage us.