Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
By Socket Research Team - Dec 02, 2024
Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@flex-development/errnode
Advanced tools
errnode
Universal API for creating Node.js errors
Contents
What is this?
This package provides a universal API for creating Node.js errors.
When should I use this?
This package is designed to help developers build ponyfills, as well as more verbose tools like
mlly, by providing a set of utilities and constructor functions for creating Node.js errors.
Install
This package is ESM only.
In Node.js (version 18+) with yarn:
yarn add @flex-development/errnode
See Git - Protocols | Yarn for details regarding installing from Git.
In Deno with esm.sh:
import { ERR_MODULE_NOT_FOUND } from 'https://esm.sh/@flex-development/errnode'
In browsers with esm.sh:
<script type="module">
import { ERR_MODULE_NOT_FOUND } from 'https://esm.sh/@flex-development/errnode'
</script>
Use
Say we have the file example.mjs:
import { ERR_INVALID_ARG_TYPE, isNodeError } from '@flex-development/errnode'
/**
* Ensure `value` is a string.
*
* @see {@linkcode ErrInvalidArgType}
*
* @param {unknown} value
* Value supplied by user
* @param {string} name
* Name of invalid argument or property
* @return {value is string}
* `true` if `value` is a string
* @throws {import('@flex-development/errnode').ErrInvalidArgType}
* If `value` is not a string
*/
function validateString(value, name) {
if (typeof value === 'string') return true
throw new ERR_INVALID_ARG_TYPE(name, 'string', value)
}
try {
validateString(null, 'path')
} catch (e) {
console.log('isNodeError:', isNodeError(e))
console.log('TypeError:', e instanceof TypeError, '\n')
throw e
}
...running node example.mjs yields:
isNodeError: true
TypeError: true
file:///node_modules/@flex-development/errnode/dist/internal/stack-trace.mjs:9
Error.captureStackTrace(error);
^
TypeError: The 'path' argument must be of type string. Received null
at __node_internal_captureLargerStackTrace (file:///node_modules/@flex-development/errnode/dist/internal/stack-trace.mjs:9:9)
at new NodeError (file:///node_modules/@flex-development/errnode/dist/e.mjs:50:45)
at validateString (file:///example.mjs:19:9)
at file:///example.mjs:23:3
at ModuleJob.run (node:internal/modules/esm/module_job:234:25)
at async ModuleLoader.import (node:internal/modules/esm/loader:473:24)
at async asyncRunEntryPointWithESMLoader (node:internal/modules/run_main:123:5) {
code: 'ERR_INVALID_ARG_TYPE'
}
API
This package exports the following identifiers:
EcodesdetermineSpecificTypeerrorsERR_ARG_NOT_ITERABLEERR_ENCODING_NOT_SUPPORTEDERR_IMPORT_ASSERTION_TYPE_FAILEDERR_IMPORT_ASSERTION_TYPE_MISSINGERR_IMPORT_ASSERTION_TYPE_UNSUPPORTEDERR_IMPORT_ATTRIBUTE_MISSINGERR_IMPORT_ATTRIBUTE_TYPE_INCOMPATIBLEERR_IMPORT_ATTRIBUTE_UNSUPPORTEDERR_INCOMPATIBLE_OPTION_PAIRERR_INVALID_ARG_TYPEERR_INVALID_ARG_VALUEERR_INVALID_FILE_URL_HOSTERR_INVALID_FILE_URL_PATHERR_INVALID_MODULE_SPECIFIERERR_INVALID_PACKAGE_CONFIGERR_INVALID_PACKAGE_TARGETERR_INVALID_RETURN_VALUEERR_INVALID_THISERR_INVALID_TUPLEERR_INVALID_URL_SCHEMEERR_INVALID_URLERR_METHOD_NOT_IMPLEMENTEDERR_MISSING_ARGSERR_MISSING_OPTIONERR_MODULE_NOT_FOUNDERR_NETWORK_IMPORT_DISALLOWEDERR_NO_CRYPTOERR_NO_ICUERR_OPERATION_FAILEDERR_PACKAGE_IMPORT_NOT_DEFINEDERR_PACKAGE_PATH_NOT_EXPORTEDERR_UNHANDLED_ERRORERR_UNKNOWN_BUILTIN_MODULEERR_UNKNOWN_ENCODINGERR_UNKNOWN_FILE_EXTENSIONERR_UNKNOWN_MODULE_FORMATERR_UNSUPPORTED_DIR_IMPORTERR_UNSUPPORTED_ESM_URL_SCHEMEERR_UNSUPPORTED_RESOLVE_REQUEST
formatListhideStackFramesisNodeErrorsyscodes
There is no default export.
Errors
Constructor functions representing Node.js error codes. Constructor arguments are used to build error messages.
Errors (and their types) can be imported individually:
import {
ERR_INVALID_MODULE_SPECIFIER,
ERR_INVALID_PACKAGE_CONFIG,
ERR_INVALID_PACKAGE_TARGET,
ERR_MODULE_NOT_FOUND,
ERR_PACKAGE_IMPORT_NOT_DEFINED,
ERR_PACKAGE_PATH_NOT_EXPORTED,
ERR_UNSUPPORTED_DIR_IMPORT,
type ErrInvalidModuleSpecifier,
type ErrInvalidModuleSpecifierArgs,
type ErrInvalidModuleSpecifierConstructor,
type ErrInvalidPackageConfig,
type ErrInvalidPackageConfigArgs,
type ErrInvalidPackageConfigConstructor,
type ErrInvalidPackageTarget,
type ErrInvalidPackageTargetArgs,
type ErrInvalidPackageTargetConstructor,
type ErrModuleNotFound,
type ErrModuleNotFoundArgs,
type ErrModuleNotFoundConstructor,
type ErrPackageImportNotDefined,
type ErrPackageImportNotDefinedArgs,
type ErrPackageImportNotDefinedConstructor,
type ErrPackagePathNotExported,
type ErrPackagePathNotExportedArgs,
type ErrPackagePathNotExportedConstructor,
type ErrUnsupportedDirImport,
type ErrUnsupportedDirImportConstructor
} from '@flex-development/errnode'
...or all at once using the errors export:
import { errors } from '@flex-development/errnode'
See the source code for documentation.
Note: This package does not export a constructor for every error. Submit a feature request (or pull request if
you're up for the challenge :wink:) to add a constructor.
E can be used instead, however.
E(code, Base, message)
Create a Node.js error constructor.
Constructor arguments are passed to format if the error message is a string, or message itself if it is
a function. Message functions are also called with the new Node.js error instance as this.
Signatures
function E<T extends NodeErrorConstructor>(
code: T['prototype']['code'],
Base: ErrorConstructor,
message: MessageFn<T['prototype'], Parameters<T>> | string
): T
function E<T extends NodeError, Args extends any[] = any[]>(
code: T['code'],
Base: ErrorConstructor,
message: MessageFn<T, Args>
): NodeErrorConstructor<T, Args>
Parameters
code(Code) — error codeBase(ErrorConstructor) — base classmessage(MessageFn|string) — error message string or function
Returns
(NodeErrorConstructor) NodeError constructor.
codes
Node.js error codes.
See NODE_VERSIONS for a list of supported Node.js versions.
determineSpecificType(value)
Determine the specific type of a value for type-mismatch errors.
Parameters
value(unknown) — value to check
Returns
(string) specific type of value.
formatList(list[, type])
Create a list string in the form 'A and B' or 'A, B, ..., and Z.
Parameters
list(string | readonly string[]) — list to formattype('and' | 'or' | null | undefined, optional) — list transition type to insert before last element- default:
'and'
- default:
Returns
(string) formatted list.
hideStackFrames(fn)
Remove unnecessary frames from Node.js core errors.
Type Parameters
T(Fn) — function to wrap
Parameters
fn(T) — function to wrap
Returns
(T) the wrapped function.
isNodeError(value)
Check if value is a NodeError.
Parameters
value(unknown) — value to check
Returns
(value is NodeError) true if value is NodeError, false otherwise.
syscodes
System error codes.
See NODE_VERSIONS for a list of supported Node.js versions.
Types
This package is fully typed with TypeScript.
Code
Union of registered codes that can occur where a node error code is expected (TypeScript type).
To register new codes, augment NodeErrorMap. They will be added to this union automatically.
type Code = Extract<keyof NodeErrorMap, string>
ErrnoException<[T]>
Node.js exception object (TypeScript interface).
Type Parameters
T(SystemCode, optional) — system error code- default:
SystemCode
- default:
Extends
Error
Properties
code(T) — system error codeerrno(number) — libuv error numbermessage(string) — error message, always prefixed bysyscallandcodepath?(string | undefined) — relevant invalid pathnamesyscall(string) — failed syscall description
MessageFn<[T][, Args]>
Build an error message.
Type Parameters
T(NodeError, optional) — node error- default:
NodeError
- default:
Args(readonly any[], optional) — message arguments- default:
any[]
- default:
Parameters
this(T) — node error object...args(Args) — message arguments
Returns
(string) error message.
NodeErrorConstructor<[T][, Args]>
Node.js error constructor (TypeScript interface).
Type Parameters
T(NodeError, optional) — node error- default:
NodeError
- default:
Args(readonly any[], optional) — message arguments- default:
any[]
- default:
Signatures
new (...args: Args): T(...args: Args): T
Properties
prototype(T) — node.js error prototype
NodeErrorMap
Registry of Node.js error codes (TypeScript interface).
When developing utilities that use more codes, augment NodeErrorMap to register those codes:
declare module '@flex-development/errnode' {
interface NodeErrorMap {
ERR_CUSTOM: true
}
}
NodeError<[T]>
Node.js error object (TypeScript interface).
Type Parameters
T(Code, optional) — error code- default:
Code
- default:
Extends
Error
Properties
code(T) — error codetoString(() => string) — get a string representation of the error
Stringifiable
A value with a toString method (TypeScript interface).
Properties
toString(() => string) — get a string representation of the value
SystemCode
Union of registered codes that can occur where a system error code is expected (TypeScript type).
To register new codes, augment SystemErrorMap. They will be added to this union automatically.
type SystemCode = Extract<keyof SystemErrorMap, string>
SystemErrorMap
Registry of system error codes (TypeScript interface).
When developing utilities that use more codes, augment SystemErrorMap to register those codes:
declare module '@flex-development/errnode' {
interface SystemErrorMap {
ECUSTOM: true
}
}
Contribute
See CONTRIBUTING.md.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
3.1.1 (2024-09-21)
:package: Build
- [
c0b6dfd] deps-dev: Bump @arethetypeswrong/cli from 0.15.4 to 0.16.1 (#363) - [
efcaba4] deps-dev: Bump @arethetypeswrong/cli from 0.16.1 to 0.16.2 (#366) - [
def46ea] deps-dev: Bump @arethetypeswrong/cli from 0.16.2 to 0.16.4 (#375) - [
c6efef3] deps-dev: Bump @stylistic/eslint-plugin from 2.7.2 to 2.8.0 (#365) - [
d998e79] deps-dev: Bump cspell from 8.14.2 to 8.14.4 (#377) - [
fc275ab] deps-dev: Bump eslint-plugin-jsdoc from 50.2.2 to 50.2.3 (#373) - [
2c5e27e] deps-dev: Bump eslint-plugin-jsdoc from 50.2.3 to 50.2.4 (#379) - [
e3218a4] deps-dev: Bump eslint-plugin-n from 17.10.2 to 17.10.3 (#378) - [
f219c90] deps-dev: Bump husky from 9.1.5 to 9.1.6 (#369) - [
51854dd] deps-dev: Bump the commitlint group with 2 updates (#368) - [
327cb9a] deps-dev: Bump the eslint group with 2 updates (#362) - [
6c68c56] deps-dev: Bump the typescript-eslint group with 3 updates (#364) - [
f403218] deps-dev: Bump the typescript-eslint group with 3 updates (#374) - [
2e50160] deps-dev: Bump the vitest group with 3 updates (#371) - [
38944d3] deps-dev: Bump the vitest group with 3 updates (#372) - [
6f2ec3f] deps: Bump vite from 5.4.1 to 5.4.6 (#376)
:robot: Continuous Integration
- [
a424294] deps: Bump actions/create-github-app-token from 1.10.4 to 1.11.0 (#370) - [
5bc5098] deps: Bump actions/setup-node from 4.0.3 to 4.0.4 (#380)
:bug: Fixes
- [
78f0c70] errors:Cannot find module "@flex-development/pathe"
Keywords
FAQs
Universal API for creating Node.js errors
The npm package @flex-development/errnode receives a total of 22 weekly downloads. As such, @flex-development/errnode popularity was classified as not popular.
We found that @flex-development/errnode demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Package last updated on 21 Sep 2024
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Research
Typosquatting Cryptographic Libraries: Malicious npm Packages Threaten Crypto Developers with Keylogging and Wallet Theft
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
By Kirill Boychenko - Nov 27, 2024
Security News
Weekly Downloads Now Available in npm Package Search Results
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
By Sarah Gooding - Nov 26, 2024