summaryrefslogtreecommitdiff
path: root/node_modules/exit-hook/readme.md
diff options
context:
space:
mode:
authorakiyamn2023-09-24 23:22:21 +1000
committerakiyamn2023-09-24 23:22:21 +1000
commit4e87195739f2a5d9a05451b48773c8afdc680765 (patch)
tree9cba501844a4a11dcbdffc4050ed8189561c55ed /node_modules/exit-hook/readme.md
downloadprice-tracker-worker-4e87195739f2a5d9a05451b48773c8afdc680765.tar.gz
price-tracker-worker-4e87195739f2a5d9a05451b48773c8afdc680765.zip
Initial commit (by create-cloudflare CLI)
Diffstat (limited to 'node_modules/exit-hook/readme.md')
-rw-r--r--node_modules/exit-hook/readme.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/node_modules/exit-hook/readme.md b/node_modules/exit-hook/readme.md
new file mode 100644
index 0000000..e9eb7a2
--- /dev/null
+++ b/node_modules/exit-hook/readme.md
@@ -0,0 +1,67 @@
+# exit-hook
+
+> Run some code when the process exits
+
+The `process.on('exit')` event doesn't catch all the ways a process can exit.
+
+This package is useful for cleaning up before exiting.
+
+## Install
+
+```
+$ npm install exit-hook
+```
+
+## Usage
+
+```js
+const exitHook = require('exit-hook');
+
+exitHook(() => {
+ console.log('Exiting');
+});
+
+// You can add multiple hooks, even across files
+exitHook(() => {
+ console.log('Exiting 2');
+});
+
+throw new Error('🦄');
+
+//=> 'Exiting'
+//=> 'Exiting 2'
+```
+
+Removing an exit hook:
+
+```js
+const exitHook = require('exit-hook');
+
+const unsubscribe = exitHook(() => {});
+
+unsubscribe();
+```
+
+## API
+
+### exitHook(callback)
+
+Returns a function that removes the hook when called.
+
+#### callback
+
+Type: `Function`
+
+The callback to execute when the process exits.
+
+---
+
+<div align="center">
+ <b>
+ <a href="https://tidelift.com/subscription/pkg/npm-exit-hook?utm_source=npm-exit-hook&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+ </b>
+ <br>
+ <sub>
+ Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+ </sub>
+</div>