Skip to content

Commit e4a7f07

Browse files
eli-sterlingeli-sterling
committed
first commit
0 parents  commit e4a7f07

File tree

13 files changed

+5414
-0
lines changed

13 files changed

+5414
-0
lines changed

‎.github/workflows/nodejs.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Node.js CI
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
8+
permissions:
9+
id-token: write
10+
contents: read
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
node-version: [22.x]
18+
steps:
19+
- uses: actions/checkout@v4
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
- run: npm ci
25+
- run: npm test
26+
- name: Configure npm auth token
27+
run: npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
28+
- name: Publish to npm
29+
run: npm publish --access public --provenance
30+
env:
31+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.gitignore‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# vitepress build output
108+
**/.vitepress/dist
109+
110+
# vitepress cache directory
111+
**/.vitepress/cache
112+
113+
# Docusaurus cache and generated files
114+
.docusaurus
115+
116+
# Serverless directories
117+
.serverless/
118+
119+
# FuseBox cache
120+
.fusebox/
121+
122+
# DynamoDB Local files
123+
.dynamodb/
124+
125+
# TernJS port file
126+
.tern-port
127+
128+
# Stores VSCode versions used for testing VSCode extensions
129+
.vscode-test
130+
131+
# yarn v2
132+
.yarn/cache
133+
.yarn/unplugged
134+
.yarn/build-state.yml
135+
.yarn/install-state.gz
136+
.pnp.*
137+
138+
# jest
139+
.jest.result

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2025 Eli Sterling, eliware.org
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# [![eliware.org](https://eliware.org/logos/brand.png)](https://discord.gg/M6aTR9eTwN)
2+
3+
## @eliware/errors [![npm version](https://img.shields.io/npm/v/@eliware/errors.svg)](https://www.npmjs.com/package/@eliware/errors)[![license](https://img.shields.io/github/license/eliware/errors.svg)](LICENSE)[![build status](https://github.com/eliware/errors/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eliware/errors/actions)
4+
5+
> Minimal Node.js process-level error handler utility for uncaught exceptions, unhandled rejections, and warnings. Works in both CommonJS and ESM environments.
6+
7+
---
8+
9+
## Table of Contents
10+
11+
- [Features](#features)
12+
- [Installation](#installation)
13+
- [Usage](#usage)
14+
- [ESM Example](#esm-example)
15+
- [CommonJS Example](#commonjs-example)
16+
- [API](#api)
17+
- [TypeScript](#typescript)
18+
- [Support](#support)
19+
- [License](#license)
20+
- [Links](#links)
21+
22+
## Features
23+
24+
- Handles uncaught exceptions, unhandled rejections, and warnings
25+
- Pluggable logger (defaults to [@eliware/log](https://www.npmjs.com/package/@eliware/log))
26+
- Easy to add/remove handlers for testability
27+
- Works in both CommonJS and ESM modules
28+
29+
## Installation
30+
31+
```bash
32+
npm install @eliware/errors
33+
```
34+
35+
## Usage
36+
37+
### ESM Example
38+
39+
```js
40+
import { registerHandlers } from '@eliware/errors';
41+
registerHandlers();
42+
43+
// Or with options:
44+
// registerHandlers({ processObj: process, log: customLogger });
45+
46+
// Simulate an uncaught exception
47+
setTimeout(() => { throw new Error('Demo uncaught exception'); }, 1000);
48+
```
49+
50+
### CommonJS Example
51+
52+
```js
53+
const { registerHandlers } = require('@eliware/errors');
54+
registerHandlers();
55+
56+
// Or with options:
57+
// registerHandlers({ processObj: process, log: customLogger });
58+
59+
// Simulate an uncaught exception
60+
setTimeout(() => { throw new Error('Demo uncaught exception'); }, 1000);
61+
```
62+
63+
## API
64+
65+
### registerHandlers(options)
66+
67+
Registers process-level exception handlers. Returns an object with a `removeHandlers` function to detach all handlers (useful for testing).
68+
69+
- `options` (optional): An object with the following properties:
70+
- `processObj` (optional): The process object to attach handlers to (default: `process`)
71+
- `log` (optional): Logger for output (default: [@eliware/log](https://www.npmjs.com/package/@eliware/log))
72+
- **Returns:** `{ removeHandlers: () => void }`
73+
74+
## TypeScript
75+
76+
Type definitions are included:
77+
78+
```ts
79+
export declare function registerHandlers(
80+
options?: {
81+
processObj?: NodeJS.Process,
82+
log?: typeof import('@eliware/log')
83+
}
84+
): { removeHandlers: () => void };
85+
```
86+
87+
## Support
88+
89+
For help, questions, or to chat with the author and community, visit:
90+
91+
[![Discord](https://eliware.org/logos/discord_96.png)](https://discord.gg/M6aTR9eTwN)[![eliware.org](https://eliware.org/logos/eliware_96.png)](https://discord.gg/M6aTR9eTwN)
92+
93+
**[eliware.org on Discord](https://discord.gg/M6aTR9eTwN)**
94+
95+
## License
96+
97+
[MIT © 2025 Eli Sterling, eliware.org](LICENSE)
98+
99+
## Links
100+
101+
- [Home Page](https://eliware.org)
102+
- [GitHub](https://github.com/eliware/errors)
103+
- [npm](https://www.npmjs.com/package/@eliware/errors)
104+
- [Discord](https://discord.gg/M6aTR9eTwN)

‎example.cjs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
const log = require('@eliware/log');
2+
const { registerHandlers } = require('@eliware/errors');
3+
const { removeHandlers } = registerHandlers({ log });
4+
throw new Error('Demo uncaught exception');

‎example.mjs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import log from '@eliware/log';
2+
import { registerHandlers } from '@eliware/errors';
3+
const { removeHandlers } = registerHandlers({ log });
4+
throw new Error('Demo uncaught exception');

‎index.cjs‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
const logger = require('@eliware/log');
2+
3+
/**
4+
* Registers process-level exception handlers for uncaught exceptions, unhandled rejections, warnings, and exit events.
5+
* @param {Object} options
6+
* @param {Object} [options.processObj=process] - The process object to attach handlers to.
7+
* @param {Object} [options.log=logger] - Logger for output.
8+
* @returns {Object} { removeHandlers } - Function to remove all registered handlers (for testability).
9+
*/
10+
const registerHandlers = ({
11+
processObj = process,
12+
log = logger
13+
} = {}) => {
14+
const handlers = {
15+
uncaughtException: (err) => log.error('Uncaught Exception', {
16+
name: err?.name,
17+
message: err?.message,
18+
stack: err?.stack,
19+
error: err
20+
}),
21+
unhandledRejection: (reason, promise) => log.error('Unhandled Rejection', {
22+
reason: reason instanceof Error ? {
23+
name: reason.name,
24+
message: reason.message,
25+
stack: reason.stack,
26+
error: reason
27+
} : reason,
28+
promise
29+
}),
30+
warning: (warning) => log.warn('Warning', {
31+
name: warning?.name,
32+
message: warning?.message,
33+
stack: warning?.stack,
34+
warning
35+
})
36+
};
37+
processObj.on('uncaughtException', handlers.uncaughtException);
38+
processObj.on('unhandledRejection', handlers.unhandledRejection);
39+
processObj.on('warning', handlers.warning);
40+
const removeHandlers = () => {
41+
processObj.off('uncaughtException', handlers.uncaughtException);
42+
processObj.off('unhandledRejection', handlers.unhandledRejection);
43+
processObj.off('warning', handlers.warning);
44+
};
45+
log.debug('Exception handlers registered');
46+
return { removeHandlers };
47+
};
48+
49+
module.exports = { registerHandlers };
50+
module.exports.default = registerHandlers;

‎index.d.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import log from '@eliware/log';
2+
3+
/**
4+
* Registers process-level exception handlers for uncaught exceptions, unhandled rejections, warnings, and exit events.
5+
* @param options
6+
* @param options.processObj The process object to attach handlers to (default: process).
7+
* @param options.log Logger for output (default: log).
8+
* @returns { removeHandlers } Function to remove all registered handlers (for testability).
9+
*/
10+
export declare function registerHandlers(
11+
options?: {
12+
processObj?: NodeJS.Process,
13+
log?: typeof log
14+
}
15+
): { removeHandlers: () => void };

0 commit comments

Comments
 (0)