@e-mc/module 0.12.3 → 0.12.5

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.12.2/lib/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.12.5/lib/index.d.ts)
 
 ```typescript
 import type { LogStatus } from "./squared";
@@ -224,8 +224,8 @@ interface ModuleConstructor {
     initCpuUsage(instance?: IModule): CpuUsage;
     getCpuUsage(start: CpuUsage, format: true): string;
     getCpuUsage(start: CpuUsage, format?: boolean): number;
-    getMemUsage(format: true): string;
-    getMemUsage(format?: boolean): number;
+    getMemUsage(format: true | "%" | "b" | "gb" | "kb" | "mb" | "pb" | "tb" | "B" | "GB" | "KB" | "MB" | "PB" | "TB", free?: boolean): string;
+    getMemUsage(format?: boolean, free?: boolean): number;
     formatCpuMem(start: CpuUsage, all?: boolean): string;
     getPackageVersion(name: string | [string, string], options?: PackageVersionOptions): string;
     checkSemVer(name: string | [string, string], options: CheckSemVerOptions): boolean;
@@ -414,11 +414,11 @@ interface LoggerModule {
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.12.2/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.2/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.2/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.2/lib/node.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.2/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.5/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.5/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.5/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.5/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.5/lib/settings.d.ts
 
 * https://www.npmjs.com/package/@types/node
 

package/index.js

@@ -89,7 +89,8 @@ const SETTINGS = {
         cpu_bar_color: ['bgBlue', 'bgYellow', 'bgRed'],
         cpu_single_core: true,
         mem: true,
-        mem_format: '%'
+        mem_format: '%',
+        mem_free: false
     },
     image: true,
     compress: true,
@@ -868,7 +869,7 @@ class Module extends EventEmitter {
     static LOG_STYLE_NOTICE = Object.freeze({ titleBgColor: 'bgGrey', titleColor: 'white' });
     static LOG_STYLE_REVERSE = Object.freeze({ titleBgColor: 'bgWhite', titleColor: 'black', messageBgColor: 'bgGrey' });
     static get VERSION() {
-        return "0.12.3";
+        return "0.12.5";
     }
     static get LOG_TYPE() {
         return types_1.LOG_TYPE;
@@ -2031,15 +2032,20 @@ class Module extends EventEmitter {
         }
         return format ? '' : 0;
     }
-    static getMemUsage(format) {
+    static getMemUsage(format, free) {
         if (!VALUES["node.process.memory_usage"]) {
             return format ? '' : 0;
         }
-        const usage = process.memoryUsage();
         let result = 0;
-        for (const name in usage) {
-            if (name !== 'heapUsed') {
-                result += usage[name];
+        if (free) {
+            result = os.freemem();
+        }
+        else {
+            const usage = process.memoryUsage();
+            for (const name in usage) {
+                if (name !== 'heapUsed') {
+                    result += usage[name];
+                }
             }
         }
         if (typeof format === 'string' && format !== '%') {
@@ -2059,9 +2065,9 @@ class Module extends EventEmitter {
         return format ? formatPercent(result / MEM_TOTAL, 3) : result;
     }
     static formatCpuMem(start, all) {
-        let cpu, cpu_bar, cpu_single_core, mem, mem_format;
+        let cpu, cpu_bar, cpu_single_core, mem, mem_format, mem_free;
         if (SETTINGS.process.enabled !== false) {
-            ({ cpu, cpu_bar, cpu_single_core, mem, mem_format } = SETTINGS.process);
+            ({ cpu, cpu_bar, cpu_single_core, mem, mem_format, mem_free } = SETTINGS.process);
         }
         let result = '';
         if (cpu || all) {
@@ -2096,7 +2102,7 @@ class Module extends EventEmitter {
         }
         if (mem || all) {
             const format = mem_format || '%';
-            const usage = this.getMemUsage(format);
+            const usage = this.getMemUsage(format, mem_free);
             if (usage) {
                 result += (result ? ' ' : '') + usage + (format === '%' ? ' MEM' : '');
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/module",
-  "version": "0.12.3",
+  "version": "0.12.5",
   "description": "Module base class for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -13,18 +13,17 @@
     "directory": "src/module"
   },
   "keywords": [
-    "squared",
-    "squared-functions"
+    "squared"
   ],
   "author": "An Pham <anpham6@gmail.com>",
   "license": "BSD-3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/types": "0.12.3",
+    "@e-mc/types": "0.12.5",
     "chalk": "4.1.2",
     "file-type": "^18.7.0",
     "js-yaml": "^4.1.0",
     "mime-types": "^2.1.35",
-    "picomatch": "^4.0.2"
+    "picomatch": "^4.0.3"
   }
 }