feat!: reworked options

simonecorsi · simonecorsi · commit 8d922c21ca3a · 2021-07-01T10:40:17.000+02:00
diff --git a/README.md b/README.md
@@ -6,13 +6,14 @@
 
 <!-- toc -->
 
-- [About The Project](#about-the-project)
-- [Installation](#installation)
-- [Usage](#usage)
-  * [Arguments](#arguments)
-- [Contributing](#contributing)
-- [License](#license)
-- [Contact](#contact)
+- [fine](#fine)
+  - [About The Project](#about-the-project)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Arguments](#arguments)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Contact](#contact)
 
 <!-- tocstop -->
 
@@ -41,7 +42,7 @@ const fine = require("@scdev/fine");
 fine(
   {
     timeout: 2000,
-    catchPromisesReject: true,
+    events: ["SIGINT", "SIGTERM", "uncaughtException", "unhandledRejection"],
   },
   [
     redis.disconnect,
@@ -55,11 +56,11 @@ fine(
 
 ### Arguments
 
-| parameter      | type       | description                                                           | default |
-| -------------- | ---------- | --------------------------------------------------------------------- | ------- |
-| opts           | Object     | Options object                                                        | {}      |
-| opts.timeout   | Number     | The time before exiting the process                                   | 2000    |
-| closeFunctions | function[] | Collection of callback for custom closing events, eg: db.disconnect() |         |
+| parameter   | type       | description                                                           | default                                                            |
+| ----------- | ---------- | --------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| `timeout`   | Number     | The time before exiting the process                                   | `2000`                                                             |
+| `events`    | string[]   | The events the process will listen on                                 | `["SIGINT", "SIGTERM", "uncaughtException", "unhandledRejection"]` |
+| `callbacks` | function[] | Collection of callback for custom closing events, eg: db.disconnect() | `[]`                                                               |
 
 <!-- CONTRIBUTING -->
 
diff --git a/index.js b/index.js
@@ -6,38 +6,55 @@ const {
 
 const NOOP = () => undefined;
 
-module.exports = (opts = {}, closeFunctions = []) => {
-  const options = Object.assign(
-    {
-      timeout: 2000,
-      catchPromisesReject: true,
-    },
-    opts
-  );
+const DEFAULT_EVENTS = [
+  "SIGINT",
+  "SIGTERM",
+  "uncaughtException",
+  "unhandledRejection",
+];
 
-  let events = ["SIGINT", "SIGTERM", "uncaughtException"];
+function validateParameters(timeout, events, callbacks) {
+  if (typeof timeout !== "number") {
+    throw new TypeError("timeout parameter must be number");
+  }
+  if (!Array.isArray(events)) {
+    throw new TypeError("events parameter must be an array of strings");
+  }
 
-  if (options.catchPromisesReject) {
-    events.push("unhandledRejection");
+  if (!Array.isArray(callbacks)) {
+    throw new TypeError("callbacks parameter must be an array of functions");
+  } else {
+    callbacks.map((cb) => {
+      if (typeof cb !== "function") {
+        throw new TypeError("callback must be a function");
+      }
+    });
   }
+}
+
+module.exports = function fine(
+  timeout = 2000,
+  events = DEFAULT_EVENTS,
+  callbacks = []
+) {
+  validateParameters(timeout, events, callbacks);
+
   for (const event of events) {
     process.once(event, () => {
       const code = event.match("^SIG") ? 0 : 1;
       process.stdout.write(`[${event}] exiting with code ${code}\n`);
-      if (Array.isArray(closeFunctions)) {
-        for (const cb of closeFunctions) {
-          try {
-            if (typeof cb === "function") {
-              const p = cb();
-              if (isPromise(p)) p.catch(NOOP);
-            }
-            // eslint-disable-next-line no-empty
-          } catch (_) {}
-        }
+      for (const cb of callbacks) {
+        try {
+          if (typeof cb === "function") {
+            const p = cb();
+            if (isPromise(p)) p.catch(NOOP);
+          }
+          // eslint-disable-next-line no-empty
+        } catch (_) {}
       }
       setTimeout(() => {
         process.exit(code);
-      }, options.timeout).unref();
+      }, timeout);
     });
   }
 };
