hide-ip 1.0.0

package/index.js

@@ -0,0 +1,32 @@
+"use strict"
+
+/**
+ * 
+ * @param {String} ip ipv4 or ipv6
+ * @param {Object} options defalut {level = 2, maskChar = "*"}
+ * @returns {string}
+ */
+function hideIp(ip, options = {}) {
+    if (typeof ip != "string") return ip
+
+    const {level = 2, maskChar = "*"} = options
+    if (level <= 0) return ip
+
+    if (ip.includes(".")) {
+        const parts = ip.split(".")
+        return parts
+            .map((part, i) => (i >= parts.length - level ? maskChar.repeat(part.length) : part))
+            .join(".")
+    }
+
+    if (ip.includes(":")) {
+        const parts = ip.split(":")
+        return parts
+            .map((part, i) => (i >= parts.length - level ? maskChar.repeat(Math.max(part.length, 1)) : part))
+            .join(":")
+    }
+
+    return ip
+}
+
+module.exports = hideIp

package/package.json

@@ -0,0 +1,24 @@
+{
+    "name": "hide-ip",
+    "version": "1.0.0",
+    "description": "Mask IPv4 and IPv6 addresses with custom masking levels and characters.",
+    "license": "ISC",
+    "author": "_redgold__",
+    "type": "commonjs",
+    "main": "index.js",
+    "homepage": "https://github.com/IMJNMHTODRLA/hide-ip",
+    "repository": {
+        "type": "git",
+        "url": "http://github.com/IMJNMHTODRLA/hide-ip.git"
+    },
+    "keywords": [
+        "ip",
+        "addresses",
+        "mask",
+        "ipv4",
+        "ipv6",
+        "privacy",
+        "security",
+        "anonymize"
+    ]
+}

package/readme.md

@@ -0,0 +1,55 @@
+# hide-ip [![](https://img.shields.io/npm/v/hide-ip.svg)](https://www.npmjs.com/package/hide-ip)
+
+Mask IPv4 and IPv6 addresses with custom masking levels and characters. Simple, lightweight, and zero-dependency.
+
+## Installation
+
+### npm
+```shell
+npm install hide-ip
+```
+
+## Usage
+Mask sensitive IP addresses for logs, UI, or security purposes. Support for both IPv4 and IPv6.
+
+```js
+const hideIp = require("hide-ip")
+
+//Basic usage (Default: level 2, maskChar "*")
+hideIp("192.0.2.255")
+//-> 192.0.*.***
+
+hideIp("2001:db8:85a3:0000:0000:8a2e:0370:7334")
+//-> 2001:db8:85a3:0000:0000:8a2e:***:****
+
+//Custom masking level (How many segments to mask from the end)
+hideIp("192.0.2.255", {level: 1})
+//-> 192.0.2.***
+
+//Custom masking character
+hideIp("192.0.2.255", { maskChar: "#" })
+//-> 192.168.#.###
+
+//Handling edge cases
+hideIp("::1", { level: 1 }) //IPv6 loopback
+//-> "::*"
+
+hideIp(null) //Returns original input if not a string
+//-> null
+
+hideIp(1234)
+//-> 1234
+```
+
+## API
+
+### hideIp(ip, [options])
+
+- `ip` (String): The IPv4 or IPv6 address to mask.
+- `options` (Object):
+    - `level` (Number): Number of segments to mask starting from the end. **Default: 2**.
+    - `maskChar` (String): Character used for masking. **Default: "*"**.
+
+## License
+This software is licensed under the ISC License.
+Copyright _redgold__, 2025.