@ix-xs/node-comfort 1.0.0

package/core/CLI.js

@@ -0,0 +1,95 @@
+const { spawn, execSync } = require("node:child_process");
+const EventEmitter = require("node:events");
+
+class cli_stream {
+  #processus;
+  #events = new EventEmitter();
+
+  constructor(command, args) {
+    this.#processus = spawn(command, args, {
+      shell: true,
+      stdio: ["ignore", "pipe", "pipe"],
+    });
+
+    this.#processus.stdout.on("data", (data) => {
+      this.#events.emit("data", data.toString());
+    });
+    this.#processus.stderr.on("data", (data) => {
+      this.#events.emit("data", data.toString());
+    });
+    this.#processus.on("error", (error) => {
+      this.#events.emit("error", error);
+    });
+    this.#processus.on("exit", async (code, signal) => {
+      await this.stop();
+    });
+    this.#processus.on("close", (code, signal) => {
+      this.#events.emit("stopped", code, signal);
+    });
+  }
+
+  /**
+	 * @typedef {"error"|"data"|"stopped"} EventName
+	 * @typedef {{
+	 * error: (error: Error) => void|Promise<void>,
+	 * data: (message: string) => void|Promise<void>,
+	 * stopped: (code: number, signal: keyof import("node:child_process").ChildProcessEventMap) => void|Promise<void>,
+	 * }} EventHandler
+	 */
+  /**
+	 * @template {EventName} E
+	 * @param {E} event
+	 * @param {EventHandler[E]} handler
+	 */
+  on(event, handler) {
+    this.#events.on(event, handler);
+    return this;
+  }
+
+  async stop() {
+    return new Promise((resolve) => {
+      if (!this.#processus || this.#processus.killed) {
+        this.#processus = null;
+        return resolve();
+      }
+
+      let resolved = false;
+
+      const done = () => {
+        if (!resolved) {
+          resolved = true;
+          this.#processus = null;
+          resolve();
+        }
+      };
+
+      this.#processus.once("exit", done);
+
+      this.#processus.kill("SIGTERM");
+
+      setTimeout(() => {
+        if (this.#processus && !this.#processus.killed && !resolved) {
+          this.#processus.kill("SIGKILL");
+        }
+        done();
+      }, 5000);
+    });
+  }
+}
+
+/**
+ * @module CLI
+ * @description
+ */
+module.exports = {
+  /**
+	 * @param {string} command
+	 */
+  cli_run: (command) => {
+    return execSync(command, {
+      shell: true,
+      stdio: "pipe",
+    });
+  },
+  cli_stream,
+};

package/core/Checker.js

@@ -0,0 +1,127 @@
+const { types } = require("node:util");
+
+/**
+ * @module Checker
+ * @description
+ * Provides a collection of utility functions for checking JavaScript value types.
+ *
+ * These helpers wrap common JavaScript type checks and selected `node:util.types`
+ * methods for specific built-in objects such as Map, Set, Date, and Error.
+ *
+ * @example
+ * const nodeComfort = require("@ix-xs/node-comfort");
+ *
+ * console.log(nodeComfort.isArray([1, 2, 3])); // true
+ * console.log(nodeComfort.isNumber(42)); // true
+ * console.log(nodeComfort.isDate(new Date())); // true
+ */
+
+module.exports = {
+  /**
+	 * Checks if the value is an array.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is an array, otherwise `false`.
+	 */
+  isArray(value) {
+    return Array.isArray(value);
+  },
+
+  /**
+	 * Checks if the value is a valid number (not NaN).
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a valid number, otherwise `false`.
+	 */
+  isNumber(value) {
+    return typeof value === "number" && !Number.isNaN(value);
+  },
+
+  /**
+	 * Checks if the value is a function.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a function, otherwise `false`.
+	 */
+  isFunction(value) {
+    return typeof value === "function";
+  },
+
+  /**
+	 * Checks if the value is an object (and not `null`).
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a non-null object, otherwise `false`.
+	 */
+  isObject(value) {
+    return typeof value === "object" && value !== null;
+  },
+
+  /**
+	 * Checks if the value is a boolean.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a boolean, otherwise `false`.
+	 */
+  isBoolean(value) {
+    return typeof value === "boolean";
+  },
+
+  /**
+	 * Checks if the value is a string.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a string, otherwise `false`.
+	 */
+  isString(value) {
+    return typeof value === "string";
+  },
+
+  /**
+	 * Checks if the value is `undefined`.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is `undefined`, otherwise `false`.
+	 */
+  isUndefined(value) {
+    return typeof value === "undefined";
+  },
+
+  /**
+	 * Checks if the value is `null`.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is `null`, otherwise `false`.
+	 */
+  isNull(value) {
+    return value === null;
+  },
+
+  /**
+	 * Checks if the value is a valid `Date` object.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is an instance of `Date`, otherwise `false`.
+	 */
+  isDate(value) {
+    return types.isDate(value);
+  },
+
+  /**
+	 * Checks if the value is a `Map` instance.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a Map, otherwise `false`.
+	 */
+  isMap(value) {
+    return types.isMap(value);
+  },
+
+  /**
+	 * Checks if the value is a `Set` instance.
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a Set, otherwise `false`.
+	 */
+  isSet(value) {
+    return types.isSet(value);
+  },
+
+  /**
+	 * Checks if the value is a native JavaScript error (`Error`, `TypeError`, etc.).
+	 * @param {*} value - The value to check.
+	 * @returns {boolean} Returns `true` if the value is a native error, otherwise `false`.
+	 */
+  isError(value) {
+    return types.isNativeError(value);
+  },
+};