icanhazip-client 0.0.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sricharan Krishnan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+![banner](https://github.com/user-attachments/assets/c68adc2f-21df-42de-87b7-61439e5d56db)
+# Icanhazip Client
+A lightweight JavaScript/TypeScript client for retrieving public IP information using the icanhazip service. This package is **ESM-only** and works in modern browsers and Node.js 18+ environments that support the Fetch API. Provides support for [https://github.com/runvnc/icanhazip](https://github.com/runvnc/icanhazip)
+
+
+### Installation:
+```console
+npm install icanhazip-client
+```
+Note: If you are using Node.js, ensure your project supports ES modules.
+
+
+### Basic Usage:
+Responses are returned as objects instead of plain text to provide a consistent, extensible API that works well with TypeScript.
+
+1. Fetch your IPv4 address
+```javascript
+import { getIPV4 } from "icanhazip-client";
+const result = await getIPV4();
+console.log(result);
+// { ipv4: "8.8.8.8" }
+```
+
+2. Fetch your IPv6 address
+```javascript
+import { getIPV6 } from "icanhazip-client";
+const result = await getIPV6();
+console.log(result);
+// { ipv6: "2001:4860:4860::8888" }
+```
+
+3. Fetch connection trace information
+```javascript
+import { getIPTrace } from "icanhazip-client";
+const trace = await getIPTrace();
+console.log(trace);
+/*
+{
+  ip: "8.8.8.8",
+  loc: "IN",
+  tls: "TLSv1.3",
+  http: "h2",
+  ...
+}
+*/
+```
+
+4. Error Handling Example
+```javascript
+try {
+  const ip = await getIPV4();
+  console.log(ip);
+} catch (error) {
+  console.error("Failed to fetch IP information", error);
+}
+```
+
+### Support
+Like this project? Support it with a github star, it would mean a lot to me! Cheers and Happy Coding.

package/dist/get-full-trace/index.d.ts

@@ -0,0 +1,4 @@
+import type { IPTraceRes } from "../types/index.ts";
+declare function getFullTrace(): Promise<IPTraceRes>;
+export { getFullTrace };
+//# sourceMappingURL=index.d.ts.map

package/dist/get-full-trace/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/get-full-trace/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGpD,iBAAe,YAAY,IAAI,OAAO,CAAC,UAAU,CAAC,CA+BjD;AAGD,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/get-full-trace/index.js

@@ -0,0 +1,36 @@
+/* module */
+async function getFullTrace() {
+    /* no fetch */
+    if (typeof fetch !== "function") {
+        throw new Error("[Bad]: Global Fetch Not Available");
+    }
+    else {
+        /* fetch */
+        const URL = "https://icanhazip.com/cdn-cgi/trace";
+        const response = await fetch(URL);
+        if (!response.ok) {
+            throw new Error("[Bad]: getIPV4 Fetch Error");
+        }
+        else {
+            /* get */
+            const prelim = (await response.text()).trim();
+            const lines = prelim.split("\n");
+            /* iterate and set */
+            const ipData = {};
+            for (const line of lines) {
+                const [key, value] = line.split("=");
+                if (!key || value === undefined) {
+                    continue;
+                }
+                else {
+                    ipData[key.trim()] = value.trim();
+                }
+            }
+            /* end */
+            return ipData;
+        }
+    }
+}
+/* exports */
+export { getFullTrace };
+//# sourceMappingURL=index.js.map

package/dist/get-full-trace/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/get-full-trace/index.ts"],"names":[],"mappings":"AAGA,YAAY;AACZ,KAAK,UAAU,YAAY;IACzB,cAAc;IACd,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;SAAM,CAAC;QACN,WAAW;QACX,MAAM,GAAG,GAAG,qCAAqC,CAAC;QAClD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,SAAS;YACT,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAEjC,qBAAqB;YACrB,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,CAAC,GAAG,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBAChC,SAAS;gBACX,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBACpC,CAAC;YACH,CAAC;YAED,SAAS;YACT,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;AACH,CAAC;AAED,aAAa;AACb,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/get-ipv4/index.d.ts

@@ -0,0 +1,4 @@
+import type { IPV4Res } from "../types/index.ts";
+declare function getIPV4(): Promise<IPV4Res>;
+export { getIPV4 };
+//# sourceMappingURL=index.d.ts.map

package/dist/get-ipv4/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/get-ipv4/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,iBAAe,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAezC;AAGD,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/get-ipv4/index.js

@@ -0,0 +1,21 @@
+/* module */
+async function getIPV4() {
+    /* no fetch */
+    if (typeof fetch !== "function") {
+        throw new Error("[Bad]: Global Fetch Not Available");
+    }
+    else {
+        const URL = "https://ipv4.icanhazip.com/";
+        const response = await fetch(URL);
+        if (!response.ok) {
+            throw new Error("[Bad]: getIPV4 Fetch Error");
+        }
+        else {
+            const ipv4 = (await response.text()).trim();
+            return { ipv4 };
+        }
+    }
+}
+/* exports */
+export { getIPV4 };
+//# sourceMappingURL=index.js.map

package/dist/get-ipv4/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/get-ipv4/index.ts"],"names":[],"mappings":"AAGA,YAAY;AACZ,KAAK,UAAU,OAAO;IACpB,cAAc;IACd,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,GAAG,6BAA6B,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5C,OAAO,EAAE,IAAI,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC;AAED,aAAa;AACb,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/get-ipv6/index.d.ts

@@ -0,0 +1,4 @@
+import type { IPV6Res } from "../types/index.ts";
+declare function getIPV6(): Promise<IPV6Res>;
+export { getIPV6 };
+//# sourceMappingURL=index.d.ts.map

package/dist/get-ipv6/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/get-ipv6/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,iBAAe,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAezC;AAGD,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/get-ipv6/index.js

@@ -0,0 +1,21 @@
+/* module */
+async function getIPV6() {
+    /* no fetch */
+    if (typeof fetch !== "function") {
+        throw new Error("[Bad]: Global Fetch Not Available");
+    }
+    else {
+        const URL = "https://ipv6.icanhazip.com/";
+        const response = await fetch(URL);
+        if (!response.ok) {
+            throw new Error("[Bad]: getIPV6 Fetch Error");
+        }
+        else {
+            const ipv6 = (await response.text()).trim();
+            return { ipv6 };
+        }
+    }
+}
+/* exports */
+export { getIPV6 };
+//# sourceMappingURL=index.js.map

package/dist/get-ipv6/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/get-ipv6/index.ts"],"names":[],"mappings":"AAGA,YAAY;AACZ,KAAK,UAAU,OAAO;IACpB,cAAc;IACd,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,GAAG,6BAA6B,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5C,OAAO,EAAE,IAAI,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC;AAED,aAAa;AACb,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./get-ipv4/index.js";
+export * from "./get-ipv6/index.js";
+export * from "./get-full-trace/index.js";
+export * from "./types/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+/* exports */
+export * from "./get-ipv4/index.js";
+export * from "./get-ipv6/index.js";
+export * from "./get-full-trace/index.js";
+export * from "./types/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,aAAa;AACb,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export type IPV4Res = {
+    ipv4: string;
+};
+export type IPV6Res = {
+    ipv6: string;
+};
+export type IPTraceRes = Record<string, any>;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAAC;AACrC,MAAM,MAAM,OAAO,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAAC;AACrC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "icanhazip-client",
+  "description": "Tiny fetch-based client for icanhazip.com (IPv4, IPv6, trace)",
+  "type": "module",
+  "version": "0.0.9",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": ["ip", "ipv4", "ipv6", "icanhazip", "icanhazip-client"],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NPM-Workbench/icanhazip-client"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/NPM-Workbench/icanhazip-client",
+  "bugs": {
+    "url": "https://github.com/NPM-Workbench/icanhazip-client/issues"
+  }
+}