geoip-lite2 2.0.3 → 2.1.1

package/.gitignore

@@ -0,0 +1,3 @@
+.idea
+node_modules
+tmp

package/AUTHORS

@@ -0,0 +1,2 @@
+Philip Tellis <philip@bluesmoon.info> (https://bluesmoon.info)
+Arturs Sosins <@ar2rsawseen>

package/README.md

@@ -1,11 +1,16 @@
-🗺️ GeoIP-Lite2
+🗺️ GeoIP-Lite2 v2.1 - Now even faster!
 ==========
-A native NodeJS API for the GeoLite data from MaxMind.
+A native Node.js API for the GeoLite data from MaxMind.
 
-This product includes GeoLite data created by MaxMind, available from https://www.maxmind.com
+This product includes GeoLite data created by MaxMind, available from: https://www.maxmind.com
 
-> **Note**
-> You MUST update the data files after installation. The MaxMind license does not allow us to distribute the latest version of the data files with this package. Follow the instructions under update the datafiles for details.
+<a href="https://www.npmjs.com/package/geoip-lite2" target="_blank" title="geoip-lite2 - npm" style="text-decoration:none">
+    <img src="https://img.shields.io/npm/dt/geoip-lite2?maxAge=3600" alt="The number of downloads">
+    <img src="https://img.shields.io/github/last-commit/sefinek24/geoip-lite2" alt="Last commit">
+    <img src="https://img.shields.io/github/issues/sefinek24/geoip-lite2" alt="Issues">
+    <img src="https://img.shields.io/github/commit-activity/w/sefinek24/geoip-lite2" alt="Commit activity">
+    <img src="https://img.shields.io/github/languages/code-size/sefinek24/geoip-lite2" alt="Code size">
+</a>
 
 🚀 Improved GeoIP Module by [Sefinek](https://sefinek.net)
 ------------
@@ -14,11 +19,19 @@ This module is an improved and updated edition of [geoip-lite](https://github.co
 All components have undergone meticulous updates to ensure peak performance and functionality.
 Notably, it is now powered by the most up-to-date MaxMind database, offering significantly enhanced accuracy and reliability. This translates to approximately 40% more precise geolocation data for any IP address, compared to the previous version which relied on a database from 2019.
 
+Now this module operates even faster because its files have been minified!
+
 Furthermore, the testing process has been improved by adopting the testing library Mocha.
 This change enhances testing and contributes to the overall reliability of the module.
 
 > I am not the creator of this npm module! All copyright rights belong to its original [Creators](AUTHORS).
 
+✨ Demonstration
+------------
+You can see this module in action on my official API. Generally speaking, the API interface is public, and you can safely use it in your projects. Happy coding!
+
+> Endpoint : https://api.sefinek.net/api/v2/geoip/{ip}  
+> Example  : https://api.sefinek.net/api/v2/geoip/109.207.159.255
 
 📑 Introduction
 ------------
@@ -26,12 +39,15 @@ MaxMind provides a set of data files for IP to Geo mapping along with opensource
 One would typically write a wrapper around their C API to get access to this data in other languages (like JavaScript).
 
 GeoIP-Lite instead attempts to be a fully native JavaScript library. A converter script converts the CSV files from MaxMind into
-an internal binary format (note that this is different from the binary data format provided by MaxMind). The geoip module uses this
+an internal binary format (note that this is different from the binary data format provided by MaxMind). The geo-ip module uses this
 binary file to lookup IP addresses and return the country, region and city that it maps to.
 
 Both IPv4 and IPv6 addresses are supported, however since the GeoLite IPv6 database does not currently contain any city or region
 information, city, region and postal code lookups are only supported for IPv4.
 
+> **Warning**
+> **You MUST update the data files after installation.** The MaxMind license does not allow us to distribute the latest version of the data files with this package. Follow the instructions under update the datafiles for details.
+
 
 📚 Philosophy
 ----------
@@ -41,7 +57,7 @@ My prime motivator was the fact that it was really hard to get libgeoip built fo
 
 🕵️‍♂️ Why GeoIP-Lite?
 -------------
-GeoIP-Lite is a fully JavaScript implementation of the MaxMind geoip API. It is not as fully featured as bindings that use `libgeoip`.
+GeoIP-Lite is a fully JavaScript implementation of the MaxMind GeoIP API. It is not as fully featured as bindings that use `libgeoip`.
 By reducing scope, this package is about 40% faster at doing lookups. On average, an IP to Location lookup should take 20 microseconds on
 a Macbook Pro. IPv4 addresses take about 6 microseconds, while IPv6 addresses take about 30 microseconds.
 
@@ -82,17 +98,19 @@ npm install geoip-lite2
 ```
 
 ### 2. Update the datafiles (optional)
-Run `cd node_modules/geoip-lite2 && npm run-script updatedb license_key=YOUR_LICENSE_KEY` to update the data files. (Replace `YOUR_LICENSE_KEY` with your license key obtained from [maxmind.com](https://support.maxmind.com/hc/en-us/articles/4407111582235-Generate-a-License-Key))
+Run `cd node_modules/geoip-lite2 && npm run updatedb license_key=YOUR_LICENSE_KEY` to update the data files. (Replace `YOUR_LICENSE_KEY` with your license key obtained from [maxmind.com](https://support.maxmind.com/hc/en-us/articles/4407111582235-Generate-a-License-Key))
 
-You can create maxmind account [here](https://www.maxmind.com/en/geolite2/signup)
+You can create maxmind account [here](https://www.maxmind.com/en/geolite2/signup).
 
-**NOTE** that this requires a lot of RAM. It is known to fail on a Digital Ocean or AWS micro instance.
-There are no plans to change this. GeoIP-Lite2 stores all data in RAM in order to be fast.
+> **Note**
+> This requires a lot of RAM. It is known to fail on a Digital Ocean or AWS micro instance.
+> There are no plans to change this. GeoIP-Lite2 stores all data in RAM in order to be fast.
+> If you need an external API that provides GeoIP, you can use [this](#-demonstration).
 
 
 🧩 API
 ---
-geoip-lite2 is completely synchronous. There are no callbacks involved.
+GeoIP-Lite2 is completely synchronous. There are no callbacks involved.
 All blocking file IO is done at startup time, so all runtime calls are executed in-memory and are fast.
 Startup may take up to 200ms while it reads into memory and indexes data files.
 
@@ -176,7 +194,7 @@ You can do it programmatically, calling after scheduled data updates
 geoip.reloadDataSync();
 
 // Asynchronously
-geoip.reloadData(function() {
+geoip.reloadData(() => {
     console.log('Done');
 });
 ```
@@ -198,25 +216,27 @@ however it is the best available for free. You can use the commercial GeoIP data
 accuracy by buying a license from MaxMind, and then using the conversion utility to convert it to a format that
 GeoIP-Lite understands. You will need to use the `.csv` files from MaxMind for conversion.
 
-Also note that on occassion, the library may take up to 5 seconds to load into memory. This is largely dependent on
+Also note that on occasion, the library may take up to 5 seconds to load into memory. This is largely dependent on
 how busy your disk is at that time. It can take as little as 200ms on a lightly loaded disk. This is a one time
 cost though, and you make it up at run time with very fast lookups.
 
 ### Memory usage
-Quick test on memory consumption shows that library uses around 100Mb per process
+Quick test on memory consumption shows that library uses around 100Mb per process.
 
 ```javascript
-    const geoip2 = require('geoip-lite2');
-    console.log(process.memoryUsage());
-    /**
-    * Outputs:
-    * {
-    *     rss: 126365696,
-    *     heapTotal: 10305536,
-    *     heapUsed: 5168944,
-    *     external: 104347120
-    * }
-    **/
+const geoip2 = require('geoip-lite2');
+console.log(process.memoryUsage());
+
+/**
+ * Output:
+ * {
+ *     rss: 126365696,
+ *     heapTotal: 7753728,
+ *     heapUsed: 5844880,
+ *     external: 164098897,
+ *     arrayBuffers: 163675390
+ * }
+**/
 ```
 
 

package/index.d.ts

@@ -0,0 +1,23 @@
+declare module 'geoip-lite2' {
+    export const cmp: number | any | null
+
+    export type GeoData = {
+        range: [number, number];
+        country: string;
+        region: string;
+        eu: string;
+        timezone: string;
+        city: string;
+        ll: [number, number];
+        metro: number;
+        area: number;
+    };
+
+    export function lookup(ip: string): GeoData | null;
+
+    export const pretty: (n: string | number | number[]) => string;
+    export const startWatchingDataUpdate: (callback: () => void) => void;
+    export const reloadDataSync: () => void;
+    export const reloadData: (callback: () => void) => void;
+    export const version: string;
+}