Added IPTools class.

ip2location · Jun 13, 2022 · cd382e7 · cd382e7
1 parent 8497035
commit cd382e7
Show file tree

Hide file tree

Showing 6 changed files with 456 additions and 7 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 IP2Location.com
+Copyright (c) 2022 IP2Location.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -150,4 +150,51 @@ ws.lookup(ip, addon, lang, (err, data) => {
 	}
 });
 
-```
+```
+
+## IPTOOLS CLASS
+
+## Methods
+Below are the methods supported in this module.
+
+|Method Name|Description|
+|---|---|
+|isIPV4(myIP)|Returns true if string contains an IPv4 address. Otherwise false.|
+|isIPV6(myIP)|Returns true if string contains an IPv6 address. Otherwise false.|
+|ipV4ToDecimal(myIP)|Returns the IP number for an IPv4 address.|
+|ipV6ToDecimal(myIP)|Returns the IP number for an IPv6 address.|
+|decimalToIPV4(ipNum)|Returns the IPv4 address for the supplied IP number.|
+|decimalToIPV6(ipNum)|Returns the IPv6 address for the supplied IP number.|
+|compressIPV6(myIP)|Returns the IPv6 address in compressed form.|
+|expandIPV6(myIP)|Returns the IPv6 address in expanded form.|
+|ipV4ToCIDR(ipFrom, ipTo)|Returns a list of CIDR from the supplied IPv4 range.|
+|ipV6ToCIDR(ipFrom, ipTo)|Returns a list of CIDR from the supplied IPv6 range.|
+|cidrToIPV4(cidr)|Returns the IPv4 range from the supplied CIDR.|
+|cidrToIPV6(cidr)|Returns the IPv6 range from the supplied CIDR.|
+
+## Usage
+
+```javascript
+const {IPTools} = require("ip2location-nodejs");
+
+let tools = new IPTools();
+
+console.log(tools.isIPV4("60.54.166.38"));
+console.log(tools.isIPV6("2001:4860:4860::8888"));
+console.log(tools.ipV4ToDecimal("60.54.166.38"));
+console.log(tools.ipV6ToDecimal("2001:4860:4860::8888"));
+console.log(tools.decimalToIPV4(1010214438));
+console.log(tools.decimalToIPV6("530610913025797008819807084026527744"));
+console.log(tools.compressIPV6("66:3123:4860:3234:411:23:000:000"));
+console.log(tools.expandIPV6("66:023:40:34:411:23:000:000"));
+let cidr = tools.ipV4ToCIDR("10.0.0.0", "10.10.2.255");
+for (const x of cidr) {
+	console.log(x);
+}
+cidr = tools.ipV6ToCIDR("2001:4860:4860:0000:0000:0000:0000:8888", "2001:4860:4860:0000:eeee:ffff:ffff:ffff");
+for (const x of cidr) {
+	console.log(x);
+}
+console.log(tools.cidrToIPV4("10.123.80.0/12"));
+console.log(tools.cidrToIPV6("2002:1234::abcd:ffff:c0a8:101/62"));
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "ip2location-nodejs",
-	"version": "9.1.0",
+	"version": "9.2.0",
 	"description": "IP2Location geolocation component",
 	"keywords": [
 		"ip2location",

diff --git a/src/ip2location.d.ts b/src/ip2location.d.ts
@@ -97,4 +97,20 @@ export class IP2LocationWebService {
     lookup(myIP: any, addOn: any, lang: any, callback: any): void;
     getCredit(callback: any): void;
     #private;
-}
+}
+export class IPTools {
+    isIPV4(myIP: any): any;
+    isIPV6(myIP: any): any;
+    ipV4ToDecimal(myIP: any): number;
+    ipV6ToDecimal(myIP: any): any;
+    decimalToIPV4(ipNum: any): string;
+    decimalToIPV6(ipNum: any): any;
+    compressIPV6(myIP: any): any;
+    expandIPV6(myIP: any): any;
+    ipV4ToCIDR(ipFrom: any, ipTo: any): string[];
+    ipToBinary(myIP: any): any;
+    binaryToIP(myBin: any): any;
+    ipV6ToCIDR(ipFrom: any, ipTo: any): string[];
+    cidrToIPV4(cidr: any): string[];
+    cidrToIPV6(cidr: any): any[];
+}