get-device-ip 1.0.1 → 1.0.2

package/README.md

@@ -4,6 +4,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 A ultra-lightweight, zero-dependency Node.js utility to quickly find your machine's local IPv4 and IPv6 addresses.
+### Use this for Backend development
 
 ### 🌟 Why use this?
 
@@ -18,16 +19,34 @@ A ultra-lightweight, zero-dependency Node.js utility to quickly find your machin
 
 ```bash
 npm install get-device-ip
+🚀 Usage
+You can now use this package in any Node.js project without extra configuration.
 
-🚀 Quick Start
-Since this is an ES Module (ESM) package, ensure your package.json has "type": "module" or use the .js extension.
+Modern (ES Modules)
+import getDeviceIP from 'get-device-ip';
 
+const ip = getDeviceIP();
+console.log('Primary IPv4:', ip.primaryIpv4);
 
+Legacy (CommonJS)
+const getDeviceIP = require('get-device-ip');
 
-import getDeviceIP from 'get-device-ip';
 const ip = getDeviceIP();
+console.log('Primary IPv4:', ip.primaryIpv4);
+
+```
+
+```
+📊 Return Object Structure
+Calling getDeviceIP() returns a clean object:
 
-console.log('My Primary IPv4:', ip.primaryIpv4);
-console.log('All IPv4 Addresses:', ip.IPv4);
+Property,Type,Description
+primaryIpv4,string,The first active local IPv4 address found.
+primaryIpv6,string,The first active local IPv6 address found.
+IPv4,string[],Array of all detected IPv4 addresses.
+IPv6,string[],Array of all detected IPv6 addresses.
 
 ```
+
+📄 License
+MIT © Sakib Fakir

package/dist/script.js

@@ -0,0 +1,61 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// script.js
+var script_exports = {};
+__export(script_exports, {
+  default: () => script_default
+});
+module.exports = __toCommonJS(script_exports);
+var import_os = __toESM(require("os"));
+var getDeviceIP = () => {
+  const IPv4 = [];
+  const IPv6 = [];
+  try {
+    const deviceInfo = import_os.default.networkInterfaces();
+    for (const interfaceName in deviceInfo) {
+      deviceInfo[interfaceName].forEach((addr) => {
+        if (addr.internal) return;
+        if (addr.family === "IPv4" || addr.family === 4) {
+          IPv4.push(addr.address);
+        } else if (addr.family === "IPv6" || addr.family === 6) {
+          IPv6.push(addr.address);
+        }
+      });
+    }
+    return {
+      IPv4,
+      IPv6,
+      primaryIpv4: IPv4[0] || null,
+      primaryIpv6: IPv6[0] || null
+    };
+  } catch (error) {
+    return { error: error.message, IPv4: [], IPv6: [] };
+  }
+};
+var script_default = getDeviceIP;

package/dist/script.mjs

@@ -0,0 +1,31 @@
+// script.js
+import os from "os";
+var getDeviceIP = () => {
+  const IPv4 = [];
+  const IPv6 = [];
+  try {
+    const deviceInfo = os.networkInterfaces();
+    for (const interfaceName in deviceInfo) {
+      deviceInfo[interfaceName].forEach((addr) => {
+        if (addr.internal) return;
+        if (addr.family === "IPv4" || addr.family === 4) {
+          IPv4.push(addr.address);
+        } else if (addr.family === "IPv6" || addr.family === 6) {
+          IPv6.push(addr.address);
+        }
+      });
+    }
+    return {
+      IPv4,
+      IPv6,
+      primaryIpv4: IPv4[0] || null,
+      primaryIpv6: IPv6[0] || null
+    };
+  } catch (error) {
+    return { error: error.message, IPv4: [], IPv6: [] };
+  }
+};
+var script_default = getDeviceIP;
+export {
+  script_default as default
+};

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "get-device-ip",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A lightweight utility to get local IPv4 and IPv6 addresses.",
-  "main": "index.js",
-  "type": "module",
+  "main": "./dist/script.cjs",
+  "module": "./dist/script.js",
   "exports": {
-    ".": "./index.js"
+    ".": {
+      "import": "./dist/script.js",
+      "require": "./dist/script.cjs"
+    }
+  },
+  "scripts": {
+    "build": "tsup script.js --format cjs,esm --clean",
+    "prepublishOnly": "npm run build"
   },
   "author": "Sakib Fakir",
   "license": "MIT",
@@ -19,5 +26,12 @@
     "local-ip",
     "device-ip",
     "network"
+  ],
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "files": [
+    "dist"
   ]
 }

package/script.js

@@ -1,42 +0,0 @@
-import os from 'os';
-// Sakib Fakir
-// published : 1/31/2026
-
-
-const getDeviceIP = () => {
-    const IPv4 = [];
-    const IPv6 = [];
-
-    try {
-        const deviceInfo = os.networkInterfaces();
-
-        for (const interfaceName in deviceInfo) {
-            deviceInfo[interfaceName].forEach((addr) => {
-                // Skip internal (loopback) addresses
-                if (addr.internal) return;
-
-                // Check for IPv4 (supports string 'IPv4' or number 4)
-                if (addr.family === 'IPv4' || addr.family === 4) {
-                    IPv4.push(addr.address);
-                } 
-                // Check for IPv6 (supports string 'IPv6' or number 6)
-                else if (addr.family === 'IPv6' || addr.family === 6) {
-                    IPv6.push(addr.address);
-                }
-            });
-        }
-
-        return { 
-            IPv4, 
-            IPv6, 
-            primaryIpv4: IPv4[0] || null, 
-            primaryIpv6: IPv6[0] || null 
-        };
-
-    } catch (error) {
-     
-        return { error: error.message, IPv4: [], IPv6: [] };
-    }
-}
-
-export default getDeviceIP;