Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaqchase/shinu
Shinu - Elegant Process Exception Handling
https://github.com/chaqchase/shinu
unhandled-errors unhandled-exceptions unhandled-rejection
Last synced: 5 days ago
JSON representation
Shinu - Elegant Process Exception Handling
- Host: GitHub
- URL: https://github.com/chaqchase/shinu
- Owner: chaqchase
- License: mit
- Created: 2023-02-21T14:40:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-12T23:30:17.000Z (over 1 year ago)
- Last Synced: 2024-12-29T00:24:38.412Z (8 days ago)
- Topics: unhandled-errors, unhandled-exceptions, unhandled-rejection
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/shinu
- Size: 125 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shinu - Elegant Process Exception Handling
Shinu is a lightweight Node.js library that makes it easy to handle signals and other process events in your application. It provides a simple interface for registering signal handlers and logging process information.
## Features
- Simple API for adding and removing signal handlers
- Default signal handlers for common signals (SIGINT, SIGTERM, SIGQUIT)
- Option to log process information for debugging purposes
- Option to handle uncaught exceptions and unhandled rejections
## Installation
You can install Shinu using npm or yarn:
```bash
npm install shinu
```
or
```bash
yarn add shinu
```
## Usage
Here's an example of how to use Shinu to handle the SIGINT signal:
```js
const { Shinu } = require('shinu');
const shinu = new Shinu();
shinu.addHandler('SIGINT', (signal) => {
console.log(`Received ${signal}`);
process.exit(0);
});
shinu.start();
```
In this example, we create a new `Shinu` instance and add a handler for the `SIGINT` signal. The handler simply logs a message and exits the process. We then call the `start` method to begin listening for signals.
By default, Shinu includes handlers for the `SIGINT`, `SIGTERM`, and `SIGQUIT` signals, so you don't need to add these manually.
You can also pass options to the `Shinu` constructor to customize its behavior:
```js
const { Shinu } = require('shinu');
const shinu = new Shinu({
debug: true,
handlers: [
{
signal: 'SIGUSR1',
handler: (signal) => {
console.log(`Received ${signal}`);
},
},
],
});
shinu.start();
```
In this example, we pass an options object to the `Shinu` constructor to enable debug logging and add a custom signal handler for `SIGUSR1`.
## API
### `new Shinu(options: IShinuOptions)`
Creates a new `Shinu` instance with the specified options.
```js
const shinu = new Shinu({
debug: true,
handlers: [
{
signal: 'SIGUSR1',
handler: (signal) => {
console.log(`Received ${signal}`);
},
},
],
});
```
#### `options.debug`
Type: `boolean`
Default: `false`
Enables debug mode. When debug mode is enabled, Shinu will log detailed process information for each signal received.
#### `options.handlers`
Type: `IHandler[]`
Default: `[]`
An array of signal handlers to register when the `Shinu` instance is started.
#### `options.logger`
Type: `(message: string) => void`
Default: `console.log`
A function that will be called to log messages. You can use your own logger or replace the default `console.log` method.
#### `options.handleUncaughtException`
Type: `boolean`
Default: `false`
Enables handling of uncaught exceptions. When this option is enabled, Shinu will log any uncaught exceptions and exit the process.
#### `options.handleUnhandledRejection`
Type: `boolean`
Default: `false`
Enables handling of unhandled rejections. When this option is enabled, Shinu will log any unhandled rejections and exit the process.
### `shinu.addHandler(signal: signals, handler: handler)`
Adds a handler function for the specified signal.
```js
shinu.addHandler('SIGUSR1', (signal) => {
console.log(`Received ${signal}`);
});
```
### `shinu.removeHandler(signal: signals, handler?: handler)`
Removes the specified handler function for the specified signal. If no handler function is provided, removes all handlers for the signal.
```js
shinu.removeHandler('SIGUSR1');
```
### `shinu.removeAllHandlers()`
Removes all registered signal handlers.
```js
shinu.removeAllHandlers();
```
### `shinu.start()`
Starts listening for registered signals and runs any associated handlers.
```js
shinu.start();
```
### `shinu.isHandlerAdded(signal: signals, handler: handler)`
Returns `true` if the specified handler function is registered for the specified signal, `false` otherwise.
```js
const isHandlerAdded = shinu.isHandlerAdded('SIGUSR1', myHandlerFunction);
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.