ipwhois 1.0.0

package/README.md

@@ -0,0 +1,203 @@
+# IPWhois Node Module
+
+A lightweight Node.js module for fetching IP geolocation information using the [ipwhois.app](https://ipwhois.app) API.
+
+## Features
+
+- 🚀 Simple and easy to use
+- 📦 Zero dependencies (uses native Node.js fetch)
+- 🔒 TypeScript support with full type definitions
+- ⚡ Works with Node.js 20+
+- 🌍 Get geolocation info for any IP or your current IP
+- ⏱️ Configurable timeout support
+
+## Installation
+
+```bash
+npm install
+npm run build
+```
+
+## Usage
+
+### JavaScript (CommonJS)
+
+```javascript
+const { ipwhois, getIpInfo, getMyIpInfo } = require("ipwhois");
+
+// Get info for your current IP
+async function example1() {
+  const info = await getMyIpInfo();
+  console.log(info);
+}
+
+// Get info for a specific IP
+async function example2() {
+  const info = await getIpInfo("8.8.8.8");
+  console.log(info.country); // "United States"
+  console.log(info.city); // "Mountain View"
+}
+
+// Using the main function with options
+async function example3() {
+  const info = await ipwhois({
+    ip: "1.1.1.1",
+    timeout: 5000,
+  });
+  console.log(info);
+}
+```
+
+### TypeScript
+
+```typescript
+import { ipwhois, getIpInfo, getMyIpInfo, IpWhoisResponse } from "ipwhois";
+
+// Get info for your current IP
+const myInfo: IpWhoisResponse = await getMyIpInfo();
+
+// Get info for a specific IP
+const googleDns: IpWhoisResponse = await getIpInfo("8.8.8.8");
+
+// With options
+const info: IpWhoisResponse = await ipwhois({
+  ip: "1.1.1.1",
+  timeout: 10000,
+});
+```
+
+## API
+
+### `ipwhois(options?)`
+
+Main function to fetch IP geolocation information.
+
+**Parameters:**
+
+- `options` (optional): Configuration object
+  - `ip` (string, optional): IP address to lookup. If not provided, returns info for your current IP
+  - `timeout` (number, optional): Request timeout in milliseconds (default: 10000)
+
+**Returns:** `Promise<IpWhoisResponse>`
+
+### `getIpInfo(ip, timeout?)`
+
+Convenience function to fetch info for a specific IP address.
+
+**Parameters:**
+
+- `ip` (string): IP address to lookup
+- `timeout` (number, optional): Request timeout in milliseconds
+
+**Returns:** `Promise<IpWhoisResponse>`
+
+### `getMyIpInfo(timeout?)`
+
+Convenience function to fetch info for your current IP address.
+
+**Parameters:**
+
+- `timeout` (number, optional): Request timeout in milliseconds
+
+**Returns:** `Promise<IpWhoisResponse>`
+
+## Response Format
+
+```typescript
+{
+  About_Us: string;
+  ip: string;
+  success: boolean;
+  type: string;
+  continent: string;
+  continent_code: string;
+  country: string;
+  country_code: string;
+  country_flag: string;
+  country_capital: string;
+  country_phone: string;
+  country_neighbours: string;
+  region: string;
+  city: string;
+  latitude: number;
+  longitude: number;
+  asn: string;
+  org: string;
+  isp: string;
+  timezone: string;
+  timezone_name: string;
+  timezone_dstOffset: number;
+  timezone_gmtOffset: number;
+  timezone_gmt: string;
+  currency: string;
+  currency_code: string;
+  currency_symbol: string;
+  currency_rates: number;
+  currency_plural: string;
+}
+```
+
+## Example Response
+
+```json
+{
+  "About_Us": "https://ipwhois.io",
+  "ip": "8.8.8.8",
+  "success": true,
+  "type": "IPv4",
+  "continent": "North America",
+  "continent_code": "NA",
+  "country": "United States",
+  "country_code": "US",
+  "country_flag": "https://cdn.ipwhois.io/flags/us.svg",
+  "country_capital": "Washington",
+  "country_phone": "+1",
+  "country_neighbours": "CA,MX",
+  "region": "California",
+  "city": "Mountain View",
+  "latitude": 37.405992,
+  "longitude": -122.078515,
+  "asn": "AS15169",
+  "org": "Google LLC",
+  "isp": "Google LLC",
+  "timezone": "America/Los_Angeles",
+  "timezone_name": "PST",
+  "timezone_dstOffset": 3600,
+  "timezone_gmtOffset": -28800,
+  "timezone_gmt": "-08:00",
+  "currency": "US Dollar",
+  "currency_code": "USD",
+  "currency_symbol": "$",
+  "currency_rates": 1,
+  "currency_plural": "US dollars"
+}
+```
+
+## Error Handling
+
+```javascript
+try {
+  const info = await getIpInfo("8.8.8.8");
+  console.log(info);
+} catch (error) {
+  console.error("Error:", error.message);
+}
+```
+
+## Running Tests
+
+```bash
+npm test
+```
+
+## Requirements
+
+- Node.js 22 or higher (for native fetch support)
+
+## License
+
+MIT
+
+## Credits
+
+This module uses the [ipwhois.app](https://ipwhois.app) API.

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { IpWhoisResponse, IpWhoisOptions } from './types';
+/**
+ * Fetches IP geolocation information from ipwhois.app API
+ *
+ * @param options - Optional configuration
+ * @returns Promise resolving to IP geolocation data
+ * @throws Error if the API request fails or returns an error
+ *
+ * @example
+ * ```typescript
+ * // Get info for current IP
+ * const info = await ipwhois();
+ *
+ * // Get info for specific IP
+ * const info = await ipwhois({ ip: '8.8.8.8' });
+ * ```
+ */
+export declare function ipwhois(options?: IpWhoisOptions): Promise<IpWhoisResponse>;
+/**
+ * Fetches IP geolocation information for a specific IP address
+ *
+ * @param ip - IP address to lookup
+ * @param timeout - Optional timeout in milliseconds
+ * @returns Promise resolving to IP geolocation data
+ *
+ * @example
+ * ```typescript
+ * const info = await getIpInfo('8.8.8.8');
+ * console.log(info.country); // "United States"
+ * ```
+ */
+export declare function getIpInfo(ip: string, timeout?: number): Promise<IpWhoisResponse>;
+/**
+ * Fetches IP geolocation information for the caller's IP address
+ *
+ * @param timeout - Optional timeout in milliseconds
+ * @returns Promise resolving to IP geolocation data
+ *
+ * @example
+ * ```typescript
+ * const info = await getMyIpInfo();
+ * console.log(info.ip); // Your IP address
+ * ```
+ */
+export declare function getMyIpInfo(timeout?: number): Promise<IpWhoisResponse>;
+export type { IpWhoisResponse, IpWhoisError, IpWhoisOptions } from './types';
+export default ipwhois;
+//# 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":"AAAA,OAAO,EAAE,eAAe,EAAgB,cAAc,EAAE,MAAM,SAAS,CAAC;AAIxE;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CA+ChF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAEtF;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAE5E;AAGD,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG7E,eAAe,OAAO,CAAC"}

package/dist/index.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ipwhois = ipwhois;
+exports.getIpInfo = getIpInfo;
+exports.getMyIpInfo = getMyIpInfo;
+const BASE_URL = 'https://ipwhois.app/json';
+/**
+ * Fetches IP geolocation information from ipwhois.app API
+ *
+ * @param options - Optional configuration
+ * @returns Promise resolving to IP geolocation data
+ * @throws Error if the API request fails or returns an error
+ *
+ * @example
+ * ```typescript
+ * // Get info for current IP
+ * const info = await ipwhois();
+ *
+ * // Get info for specific IP
+ * const info = await ipwhois({ ip: '8.8.8.8' });
+ * ```
+ */
+async function ipwhois(options) {
+    const { ip, timeout = 10000 } = options || {};
+    // Build URL
+    const url = ip ? `${BASE_URL}/${ip}` : BASE_URL;
+    try {
+        // Create AbortController for timeout
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), timeout);
+        // Make request using native fetch (available in Node 20+)
+        const response = await fetch(url, {
+            method: 'GET',
+            headers: {
+                'Accept': 'application/json',
+                'User-Agent': 'ipwhois-node-module/1.0.0'
+            },
+            signal: controller.signal
+        });
+        clearTimeout(timeoutId);
+        // Check if response is ok
+        if (!response.ok) {
+            throw new Error(`HTTP error! status: ${response.status}`);
+        }
+        // Parse JSON response
+        const data = await response.json();
+        // Check if the API returned an error
+        if ('success' in data && data.success === false) {
+            throw new Error(data.message || 'API returned an error');
+        }
+        return data;
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            if (error.name === 'AbortError') {
+                throw new Error(`Request timeout after ${timeout}ms`);
+            }
+            throw error;
+        }
+        throw new Error('Unknown error occurred');
+    }
+}
+/**
+ * Fetches IP geolocation information for a specific IP address
+ *
+ * @param ip - IP address to lookup
+ * @param timeout - Optional timeout in milliseconds
+ * @returns Promise resolving to IP geolocation data
+ *
+ * @example
+ * ```typescript
+ * const info = await getIpInfo('8.8.8.8');
+ * console.log(info.country); // "United States"
+ * ```
+ */
+async function getIpInfo(ip, timeout) {
+    return ipwhois({ ip, timeout });
+}
+/**
+ * Fetches IP geolocation information for the caller's IP address
+ *
+ * @param timeout - Optional timeout in milliseconds
+ * @returns Promise resolving to IP geolocation data
+ *
+ * @example
+ * ```typescript
+ * const info = await getMyIpInfo();
+ * console.log(info.ip); // Your IP address
+ * ```
+ */
+async function getMyIpInfo(timeout) {
+    return ipwhois({ timeout });
+}
+// Default export
+exports.default = ipwhois;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAoBA,0BA+CC;AAeD,8BAEC;AAcD,kCAEC;AAlGD,MAAM,QAAQ,GAAG,0BAA0B,CAAC;AAE5C;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,OAAO,CAAC,OAAwB;IACpD,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,KAAK,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE9C,YAAY;IACZ,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IAEhD,IAAI,CAAC;QACH,qCAAqC;QACrC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;QAEhE,0DAA0D;QAC1D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,QAAQ,EAAE,kBAAkB;gBAC5B,YAAY,EAAE,2BAA2B;aAC1C;YACD,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC,CAAC;QAEH,YAAY,CAAC,SAAS,CAAC,CAAC;QAExB,0BAA0B;QAC1B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,sBAAsB;QACtB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAoC,CAAC;QAErE,qCAAqC;QACrC,IAAI,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAE,IAAqB,CAAC,OAAO,IAAI,uBAAuB,CAAC,CAAC;QAC7E,CAAC;QAED,OAAO,IAAuB,CAAC;IAEjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,yBAAyB,OAAO,IAAI,CAAC,CAAC;YACxD,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,SAAS,CAAC,EAAU,EAAE,OAAgB;IAC1D,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,WAAW,CAAC,OAAgB;IAChD,OAAO,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;AAC9B,CAAC;AAKD,iBAAiB;AACjB,kBAAe,OAAO,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Response from the ipwhois.app API
+ */
+export interface IpWhoisResponse {
+    About_Us: string;
+    ip: string;
+    success: boolean;
+    type: string;
+    continent: string;
+    continent_code: string;
+    country: string;
+    country_code: string;
+    country_flag: string;
+    country_capital: string;
+    country_phone: string;
+    country_neighbours: string;
+    region: string;
+    city: string;
+    latitude: number;
+    longitude: number;
+    asn: string;
+    org: string;
+    isp: string;
+    timezone: string;
+    timezone_name: string;
+    timezone_dstOffset: number;
+    timezone_gmtOffset: number;
+    timezone_gmt: string;
+    currency: string;
+    currency_code: string;
+    currency_symbol: string;
+    currency_rates: number;
+    currency_plural: string;
+}
+/**
+ * Error response when the API request fails
+ */
+export interface IpWhoisError {
+    success: false;
+    message: string;
+}
+/**
+ * Options for the ipwhois function
+ */
+export interface IpWhoisOptions {
+    /**
+     * IP address to lookup. If not provided, returns info for the caller's IP
+     */
+    ip?: string;
+    /**
+     * Request timeout in milliseconds (default: 10000)
+     */
+    timeout?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,KAAK,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "ipwhois",
+  "version": "1.0.0",
+  "description": "A Node.js module to fetch IP geolocation information from ipwhois.app API (not official).",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "node test/example.js"
+  },
+  "keywords": [
+    "ip",
+    "geolocation",
+    "ipwhois",
+    "ip-lookup",
+    "geoip"
+  ],
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.5",
+    "typescript": "^5.7.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,113 @@
+import { IpWhoisResponse, IpWhoisError, IpWhoisOptions } from "./types";
+
+const BASE_URL = "https://ipwhois.app/json";
+
+/**
+ * Fetches IP geolocation information from ipwhois.app API
+ *
+ * @param options - Optional configuration
+ * @returns Promise resolving to IP geolocation data
+ * @throws Error if the API request fails or returns an error
+ *
+ * @example
+ * ```typescript
+ * // Get info for current IP
+ * const info = await ipwhois();
+ *
+ * // Get info for specific IP
+ * const info = await ipwhois({ ip: '8.8.8.8' });
+ * ```
+ */
+export async function ipwhois(
+  options?: IpWhoisOptions
+): Promise<IpWhoisResponse> {
+  const { ip, timeout = 10000 } = options || {};
+
+  // Build URL
+  const url = ip ? `${BASE_URL}/${ip}` : BASE_URL;
+
+  try {
+    // Create AbortController for timeout
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), timeout);
+
+    // Make request using native fetch (available in Node 20+)
+    const response = await fetch(url, {
+      method: "GET",
+      headers: {
+        Accept: "application/json",
+        "User-Agent": "ipwhois-node-module/1.0.0",
+      },
+      signal: controller.signal,
+    });
+
+    clearTimeout(timeoutId);
+
+    // Check if response is ok
+    if (!response.ok) {
+      throw new Error(`HTTP error! status: ${response.status}`);
+    }
+
+    // Parse JSON response
+    const data = (await response.json()) as IpWhoisResponse | IpWhoisError;
+
+    // Check if the API returned an error
+    if ("success" in data && data.success === false) {
+      throw new Error(
+        (data as IpWhoisError).message || "API returned an error"
+      );
+    }
+
+    return data as IpWhoisResponse;
+  } catch (error) {
+    if (error instanceof Error) {
+      if (error.name === "AbortError") {
+        throw new Error(`Request timeout after ${timeout}ms`);
+      }
+      throw error;
+    }
+    throw new Error("Unknown error occurred");
+  }
+}
+
+/**
+ * Fetches IP geolocation information for a specific IP address
+ *
+ * @param ip - IP address to lookup
+ * @param timeout - Optional timeout in milliseconds
+ * @returns Promise resolving to IP geolocation data
+ *
+ * @example
+ * ```typescript
+ * const info = await getIpInfo('8.8.8.8');
+ * console.log(info.country); // "United States"
+ * ```
+ */
+export async function getIpInfo(
+  ip: string,
+  timeout?: number
+): Promise<IpWhoisResponse> {
+  return ipwhois({ ip, timeout });
+}
+
+/**
+ * Fetches IP geolocation information for the caller's IP address
+ *
+ * @param timeout - Optional timeout in milliseconds
+ * @returns Promise resolving to IP geolocation data
+ *
+ * @example
+ * ```typescript
+ * const info = await getMyIpInfo();
+ * console.log(info.ip); // Your IP address
+ * ```
+ */
+export async function getMyIpInfo(timeout?: number): Promise<IpWhoisResponse> {
+  return ipwhois({ timeout });
+}
+
+// Export types
+export type { IpWhoisResponse, IpWhoisError, IpWhoisOptions } from "./types";
+
+// Default export
+export default ipwhois;

package/src/types.ts

@@ -0,0 +1,56 @@
+/**
+ * Response from the ipwhois.app API
+ */
+export interface IpWhoisResponse {
+  About_Us: string;
+  ip: string;
+  success: boolean;
+  type: string;
+  continent: string;
+  continent_code: string;
+  country: string;
+  country_code: string;
+  country_flag: string;
+  country_capital: string;
+  country_phone: string;
+  country_neighbours: string;
+  region: string;
+  city: string;
+  latitude: number;
+  longitude: number;
+  asn: string;
+  org: string;
+  isp: string;
+  timezone: string;
+  timezone_name: string;
+  timezone_dstOffset: number;
+  timezone_gmtOffset: number;
+  timezone_gmt: string;
+  currency: string;
+  currency_code: string;
+  currency_symbol: string;
+  currency_rates: number;
+  currency_plural: string;
+}
+
+/**
+ * Error response when the API request fails
+ */
+export interface IpWhoisError {
+  success: false;
+  message: string;
+}
+
+/**
+ * Options for the ipwhois function
+ */
+export interface IpWhoisOptions {
+  /**
+   * IP address to lookup. If not provided, returns info for the caller's IP
+   */
+  ip?: string;
+  /**
+   * Request timeout in milliseconds (default: 10000)
+   */
+  timeout?: number;
+}

package/test/example.js

@@ -0,0 +1,41 @@
+const { ipwhois, getIpInfo, getMyIpInfo } = require('../dist/index');
+
+async function runExamples() {
+  console.log('=== IP Whois Module Examples ===\n');
+  
+  try {
+    // Example 1: Get info for current IP
+    console.log('1. Getting info for your current IP...');
+    const myInfo = await getMyIpInfo();
+    console.log(`   IP: ${myInfo.ip}`);
+    console.log(`   Country: ${myInfo.country} (${myInfo.country_code})`);
+    console.log(`   City: ${myInfo.city}`);
+    console.log(`   ISP: ${myInfo.isp}`);
+    console.log(`   Timezone: ${myInfo.timezone}\n`);
+    
+    // Example 2: Get info for a specific IP (Google DNS)
+    console.log('2. Getting info for Google DNS (8.8.8.8)...');
+    const googleInfo = await getIpInfo('8.8.8.8');
+    console.log(`   IP: ${googleInfo.ip}`);
+    console.log(`   Country: ${googleInfo.country} (${googleInfo.country_code})`);
+    console.log(`   City: ${googleInfo.city}`);
+    console.log(`   Organization: ${googleInfo.org}`);
+    console.log(`   Timezone: ${googleInfo.timezone}\n`);
+    
+    // Example 3: Using main function with options
+    console.log('3. Getting info for Cloudflare DNS (1.1.1.1)...');
+    const cloudflareInfo = await ipwhois({ ip: '1.1.1.1', timeout: 5000 });
+    console.log(`   IP: ${cloudflareInfo.ip}`);
+    console.log(`   Country: ${cloudflareInfo.country} (${cloudflareInfo.country_code})`);
+    console.log(`   City: ${cloudflareInfo.city}`);
+    console.log(`   Latitude: ${cloudflareInfo.latitude}`);
+    console.log(`   Longitude: ${cloudflareInfo.longitude}\n`);
+    
+    console.log('✅ All examples completed successfully!');
+    
+  } catch (error) {
+    console.error('❌ Error:', error.message);
+  }
+}
+
+runExamples();

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test"]
+}