npmpackage.info

Gathering detailed insights and metrics for @hypercliq/shutdown-cleanup

@hypercliq/shutdown-cleanup - 7.0.1 | npmpackage.info

@hypercliq/shutdown-cleanup

Module to handle graceful shutdowns

7.0.1

MIT

JavaScript

19.59 kB

4.1

Installations

npm install @hypercliq/shutdown-cleanup

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18

Node Version

18.20.6

NPM Version

10.8.2 Pull Requests

Open

3

Total

1,588

Closed

876

Merged

709

Issues

Open

0

Total

2

Closed

2

Releases

v7.0.1

Updated on Feb 13, 2025

v7.0.0

Updated on Nov 22, 2024

v6.0.4

Updated on Aug 30, 2024

v6.0.3

Updated on Apr 12, 2024

v6.0.2

Updated on Mar 09, 2024

5.0.1

v5.0.1

Updated on May 24, 2022

View All 13 releases

Languages

JavaScript

JavaScript (100%)

Developer

hypercliq

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

3 Stars

1,424 Commits

2 Watchers

6 Branches

1 Contributors

Updated on Feb 13, 2025

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

7.0.1

Package Id

@hypercliq/shutdown-cleanup@7.0.1

Unpacked Size

19.59 kB

Size

6.33 kB

File Count

NPM Version

10.8.2

Node Version

18.20.6

Published on

Feb 13, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@commitlint/cli @commitlint/config-conventional @eslint/js @types/node c8 chai eslint eslint-plugin-mocha eslint-plugin-unicorn globals husky lint-staged mocha prettier

Shutdown-Cleanup Module

npm npm NPM

The shutdown-cleanup module provides a structured approach for managing graceful shutdowns in Node.js applications. It supports phased shutdowns, signal-specific handlers, customizable error handling strategies, and custom exit codes, ensuring broad compatibility with LTS Node.js versions.

Features

Phased Shutdown: Organizes shutdown logic into phases for orderly execution.
Signal-Specific Handlers: Custom logic for specific signals without mandatory shutdown.
Error Handling Strategy: Customizable handling of handler errors, including proper management of synchronous and asynchronous handlers to prevent unhandled promise rejections.
Custom Exit Codes: Specify exit codes to indicate shutdown statuses.
Graceful Shutdown with Timeout: Prevents indefinite hangs during shutdown. (See Developer Guide for details.)
LTS Node.js Support: Compatible with LTS Node.js versions.
Enhanced Flexibility: Supports handling of custom application events.
TypeScript Support: Includes TypeScript definitions for ease of development.

Installation

1npm install @hypercliq/shutdown-cleanup

Or using Yarn:

1yarn add @hypercliq/shutdown-cleanup

Usage

To use shutdown-cleanup, import and utilize its functions within your application to manage shutdown logic effectively. Both synchronous and asynchronous handlers are supported.

1import { registerHandler } from '@hypercliq/shutdown-cleanup'
2
3// Asynchronous handler
4registerHandler(async (signal) => {
5  await performCleanup()
6  console.log('Async cleanup completed')
7})
8
9// Synchronous handler
10registerHandler((signal) => {
11  performSyncCleanup()
12  console.log('Sync cleanup completed')
13})

Examples and Best Practices

For more detailed usage examples and best practices, see the Developer Guide.

Contributing to Shutdown-Cleanup

We encourage contributions! If you have suggestions, bug reports, or would like to contribute code, please submit issues or pull requests on GitHub. For major changes, start by opening an issue to discuss your ideas.

Thank you for using and contributing to the shutdown-cleanup module!

How to Contribute

Fork the repository
Create a new branch for your feature or bug fix
Make your changes
Commit your changes
Push your changes to your fork
Open a pull request
Wait for review and merge
Celebrate your contribution!

Remember to add tests for your changes and ensure that all tests pass before submitting a pull request. Also, lint and format your code according to the project's standards.

License

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

4.1

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More