Added TypeScript type declarations

Author: ip2location

LICENSE.TXT

@@ -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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ip2proxy-nodejs",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "IP2Proxy proxy detection component",
   "keywords": [
     "vpn-detection",
@@ -21,9 +21,11 @@
   "files": [
     "src/ip2proxy.js",
     "src/test.js",
+    "src/ip2proxy.d.ts",
     "./README.md"
   ],
   "main": "src/ip2proxy.js",
+  "types": "src/ip2proxy.d.ts",
   "license": "MIT",
   "dependencies": {
     "big-integer": ">=1.6.8"

src/ip2proxy.d.ts

@@ -0,0 +1,75 @@
+export class IP2Proxy {
+    readRow(readBytes: any, position: any): any;
+    readBin(readBytes: any, position: any, readType: any, isBigInt: any): any;
+    read8(position: any): any;
+    read32(position: any, isBigInt: any): any;
+    read32Row(position: any, buffer: any): any;
+    read32Or128(position: any, ipType: any): any;
+    read128(position: any): any;
+    readStr(position: any): any;
+    loadBin(): boolean;
+    open(binPath: any): 0 | -1;
+    close(): 0 | -1;
+    proxyQueryData(myIP: any, ipType: any, data: any, mode: any): void;
+    proxyQuery(myIP: any, mode: any): {
+        ip: string;
+        ipNo: string;
+        isProxy: number;
+        proxyType: string;
+        countryShort: string;
+        countryLong: string;
+        region: string;
+        city: string;
+        isp: string;
+        domain: string;
+        usageType: string;
+        asn: string;
+        as: string;
+        lastSeen: string;
+        threat: string;
+        provider: string;
+    };
+    getModuleVersion(): string;
+    getPackageVersion(): number;
+    getDatabaseVersion(): string;
+    isProxy(myIP: any): number;
+    getCountryShort(myIP: any): string;
+    getCountryLong(myIP: any): string;
+    getRegion(myIP: any): string;
+    getCity(myIP: any): string;
+    getISP(myIP: any): string;
+    getProxyType(myIP: any): string;
+    getDomain(myIP: any): string;
+    getUsageType(myIP: any): string;
+    getASN(myIP: any): string;
+    getAS(myIP: any): string;
+    getLastSeen(myIP: any): string;
+    getThreat(myIP: any): string;
+    getProvider(myIP: any): string;
+    getAll(myIP: any): {
+        ip: string;
+        ipNo: string;
+        isProxy: number;
+        proxyType: string;
+        countryShort: string;
+        countryLong: string;
+        region: string;
+        city: string;
+        isp: string;
+        domain: string;
+        usageType: string;
+        asn: string;
+        as: string;
+        lastSeen: string;
+        threat: string;
+        provider: string;
+    };
+    #private;
+}
+export class IP2ProxyWebService {
+    open(apiKey: any, apiPackage: any, useSSL?: boolean): void;
+    checkParams(): void;
+    lookup(myIP: any, callback: any): void;
+    getCredit(callback: any): void;
+    #private;
+}

src/ip2proxy.js

@@ -4,7 +4,7 @@ var bigInt = require("big-integer");
 var https = require("https");
 
 // For BIN queries
-const VERSION = "4.0.0";
+const VERSION = "4.1.0";
 const MAX_INDEX = 65536;
 const COUNTRY_POSITION = [0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3];
 const REGION_POSITION = [0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 4, 4];