@alwatr/exit-hook 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0 (2024-01-03)
+
+### Features
+
+* **exit-hook:** new package ([a41b3a0](https://github.com/Alwatr/nanolib/commit/a41b3a01a4e6af595521e506326678eb96491a11)) by @njfamirm

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# Exit Hook
+
+A utility for registering exit handlers in Node.js.
+
+## Installation
+
+```bash
+yarn add @alwatr/exit-hook
+```
+
+## Usage
+
+```typescript
+import {exitHook} from '@alwatr/exit-hook';
+
+const saveAllData = () => {
+  // save all data
+};
+
+exitHook(saveAllData);
+```

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/exit-hook v1.0.0 */
+"use strict";var n=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var f=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var p=(o,e)=>{for(var r in e)n(o,r,{get:e[r],enumerable:!0})},u=(o,e,r,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let c of f(e))!x.call(o,c)&&c!==r&&n(o,c,{get:()=>e[c],enumerable:!(s=a(e,c))||s.enumerable});return o};var k=o=>u(n({},"__esModule",{value:!0}),o);var E={};p(E,{existHook:()=>b});module.exports=k(E);var i=[],l=!1;function b(o){i.push(o)}function t(){if(l!==!0){l=!0;for(let o of i)try{o()}catch(e){console.error("Error in exit hook callback:",e)}}}process.once("beforeExit",t),process.once("exit",t),process.once("SIGTERM",t),process.once("SIGINT",t);0&&(module.exports={existHook});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n  * Array of callback functions to be called when the process is exiting.\n */\nconst callbacks: (() => void)[] = [];\n\n/**\n * True whether the process is exiting to prevent calling the callbacks more than once.\n */\nlet exiting = false;\n\n/**\n * Add a callback function to be called when the process is exiting.\n *\n * @param callback The callback function to be called when the process is exiting.\n *\n * @example\n * ```typescript\n * const saveAllData = () => {\n *   // save all data\n * };\n *\n * existHook(saveAllData);\n * ```\n */\nexport function existHook(callback: () => void): void {\n  callbacks.push(callback);\n}\n\n/**\n * A once callback to be called on process exit event.\n */\nfunction onExit_() {\n  if (exiting === true) return;\n  exiting = true;\n\n  for (const callback of callbacks) {\n    try {\n      callback();\n    }\n    catch (error) {\n      console.error('Error in exit hook callback:', error);\n    }\n  }\n}\n\n/**\n * This event emitted when Node.js empties its event loop and has no additional work to schedule.\n * Normally, the Node.js process will exit when there is no work scheduled,\n * but a listener registered on the 'beforeExit' event can make asynchronous calls, and thereby cause the Node.js process to continue.\n *\n * @see https://nodejs.org/api/process.html#event-beforeexit\n */\nprocess.once('beforeExit', onExit_);\n\n/**\n * This event is emitted when the Node.js process is about to exit as a result of either:\n * 1- The `process.exit()` method being called explicitly.\n * 2- The Node.js event loop no longer having any additional work to perform.\n *\n * @see https://nodejs.org/api/process.html#event-exit\n */\nprocess.once('exit', onExit_);\n\n/**\n * This event is emitted in terminal mode before exiting with code 128 + signal number.\n *\n * @see https://nodejs.org/api/process.html#signal-events\n */\nprocess.once('SIGTERM', onExit_);\n\n/**\n * This event is emitted when `Ctrl+C` is pressed.\n *\n * @see https://nodejs.org/api/process.html#signal-events\n */\nprocess.once('SIGINT', onExit_);\n"],
+  "mappings": ";yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,eAAAE,IAAA,eAAAC,EAAAH,GAGA,IAAMI,EAA4B,CAAC,EAK/BC,EAAU,GAgBP,SAASH,EAAUI,EAA4B,CACpDF,EAAU,KAAKE,CAAQ,CACzB,CAKA,SAASC,GAAU,CACjB,GAAIF,IAAY,GAChB,CAAAA,EAAU,GAEV,QAAWC,KAAYF,EACrB,GAAI,CACFE,EAAS,CACX,OACOE,EAAO,CACZ,QAAQ,MAAM,+BAAgCA,CAAK,CACrD,EAEJ,CASA,QAAQ,KAAK,aAAcD,CAAO,EASlC,QAAQ,KAAK,OAAQA,CAAO,EAO5B,QAAQ,KAAK,UAAWA,CAAO,EAO/B,QAAQ,KAAK,SAAUA,CAAO",
+  "names": ["main_exports", "__export", "existHook", "__toCommonJS", "callbacks", "exiting", "callback", "onExit_", "error"]
+}

package/dist/main.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Add a callback function to be called when the process is exiting.
+ *
+ * @param callback The callback function to be called when the process is exiting.
+ *
+ * @example
+ * ```typescript
+ * const saveAllData = () => {
+ *   // save all data
+ * };
+ *
+ * existHook(saveAllData);
+ * ```
+ */
+export declare function existHook(callback: () => void): void;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAEpD"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/exit-hook v1.0.0 */
+var c=[],r=!1;function n(e){c.push(e)}function o(){if(r!==!0){r=!0;for(let e of c)try{e()}catch(t){console.error("Error in exit hook callback:",t)}}}process.once("beforeExit",o),process.once("exit",o),process.once("SIGTERM",o),process.once("SIGINT",o);export{n as existHook};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n  * Array of callback functions to be called when the process is exiting.\n */\nconst callbacks: (() => void)[] = [];\n\n/**\n * True whether the process is exiting to prevent calling the callbacks more than once.\n */\nlet exiting = false;\n\n/**\n * Add a callback function to be called when the process is exiting.\n *\n * @param callback The callback function to be called when the process is exiting.\n *\n * @example\n * ```typescript\n * const saveAllData = () => {\n *   // save all data\n * };\n *\n * existHook(saveAllData);\n * ```\n */\nexport function existHook(callback: () => void): void {\n  callbacks.push(callback);\n}\n\n/**\n * A once callback to be called on process exit event.\n */\nfunction onExit_() {\n  if (exiting === true) return;\n  exiting = true;\n\n  for (const callback of callbacks) {\n    try {\n      callback();\n    }\n    catch (error) {\n      console.error('Error in exit hook callback:', error);\n    }\n  }\n}\n\n/**\n * This event emitted when Node.js empties its event loop and has no additional work to schedule.\n * Normally, the Node.js process will exit when there is no work scheduled,\n * but a listener registered on the 'beforeExit' event can make asynchronous calls, and thereby cause the Node.js process to continue.\n *\n * @see https://nodejs.org/api/process.html#event-beforeexit\n */\nprocess.once('beforeExit', onExit_);\n\n/**\n * This event is emitted when the Node.js process is about to exit as a result of either:\n * 1- The `process.exit()` method being called explicitly.\n * 2- The Node.js event loop no longer having any additional work to perform.\n *\n * @see https://nodejs.org/api/process.html#event-exit\n */\nprocess.once('exit', onExit_);\n\n/**\n * This event is emitted in terminal mode before exiting with code 128 + signal number.\n *\n * @see https://nodejs.org/api/process.html#signal-events\n */\nprocess.once('SIGTERM', onExit_);\n\n/**\n * This event is emitted when `Ctrl+C` is pressed.\n *\n * @see https://nodejs.org/api/process.html#signal-events\n */\nprocess.once('SIGINT', onExit_);\n"],
+  "mappings": ";AAGA,IAAMA,EAA4B,CAAC,EAK/BC,EAAU,GAgBP,SAASC,EAAUC,EAA4B,CACpDH,EAAU,KAAKG,CAAQ,CACzB,CAKA,SAASC,GAAU,CACjB,GAAIH,IAAY,GAChB,CAAAA,EAAU,GAEV,QAAWE,KAAYH,EACrB,GAAI,CACFG,EAAS,CACX,OACOE,EAAO,CACZ,QAAQ,MAAM,+BAAgCA,CAAK,CACrD,EAEJ,CASA,QAAQ,KAAK,aAAcD,CAAO,EASlC,QAAQ,KAAK,OAAQA,CAAO,EAO5B,QAAQ,KAAK,UAAWA,CAAO,EAO/B,QAAQ,KAAK,SAAUA,CAAO",
+  "names": ["callbacks", "exiting", "existHook", "callback", "onExit_", "error"]
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@alwatr/exit-hook",
+  "version": "1.0.0",
+  "description": "A utility for registering exit handlers in Node.js.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "exit-hook",
+    "hook",
+    "exit",
+    "cross-platform",
+    "ECMAScript",
+    "typescript",
+    "javascript",
+    "node",
+    "nodejs",
+    "esm",
+    "module",
+    "utility",
+    "util",
+    "utils",
+    "nanolib",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{js,mjs,cjs,map,d.ts,html,md}",
+    "!demo/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/exit-hook"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/exit-hook#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "prettier": "@alwatr/prettier-config",
+  "scripts": {
+    "b": "yarn run build",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && ALWATR_DEBUG=1 yarn node",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build --preset=module",
+    "build:ts": "tsc --build",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist *.tsbuildinfo"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.2.3",
+    "@alwatr/prettier-config": "^1.0.4",
+    "@alwatr/tsconfig-base": "^1.1.0",
+    "@types/node": "^20.10.6",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "f78592294341aff359a6b67f703550d007056beb"
+}