3.0.0-alpha.0

Author: sefinek

README.md

@@ -72,7 +72,8 @@ You can see this module in action using my [official API](https://api.sefinek.ne
 
 
 ## 📚 Library API
-GeoIP-Lite2 is completely synchronous. It does not use callbacks. All blocking file I/O is performed at startup, so all runtime calls are executed in-memory and are fast.
+GeoIP-Lite2 performs lookups synchronously in memory (`lookup`). It also provides async data reload methods (`reloadData`) and file watcher callbacks (`startWatchingDataUpdate`).
+All blocking file I/O is performed at startup, so all runtime lookups are fast.
 Startup may take up to 200 ms while reading and indexing data files into memory.
 
 ### Looking up an IP address
@@ -104,17 +105,6 @@ If the IP address was found, the `lookup` method returns an object with the foll
 
 If the IP address was not found, `lookup` returns `null`.
 
-### Pretty printing an IP address
-If you have a 32-bit unsigned integer or a number returned as part of the `range` array,
-you can use the `pretty` method to get a human-readable format.
-
-```js
-console.log('IP is %s', geoIp.pretty(ip));
-```
-
-The method returns a string if the input format is recognized, otherwise it returns the input itself.
-
-
 ## 🔄 Built-in Updater
 This package contains an update script that downloads files from MaxMind and handles CSV conversion.
 A npm script alias has been configured to simplify this process. Internet access is required and MaxMind download limits apply.
@@ -144,10 +134,13 @@ You can do it programmatically, calling after scheduled data updates
 // Synchronously
 geoIp.reloadDataSync();
 
-// Asynchronously
+// Asynchronously (callback)
 geoIp.reloadData(() => {
     console.log('Done');
 });
+
+// Asynchronously (Promise)
+await geoIp.reloadData();
 ```
 
 #### Automatic Start and stop watching for data updates
@@ -163,11 +156,11 @@ This tool can be used with `npm run updatedb` to periodically update geo data on
 The following environment variables can be set.
 
 ```bash
-# Override the default node_modules/geoip-lite/data dir
-GEOTMPDIR=/some/path
-
-# Override the default node_modules/geoip-lite/tmp dir
+# Override the default node_modules/geoip-lite2/data dir
 GEODATADIR=/some/path
+
+# Override the default node_modules/geoip-lite2/tmp dir
+GEOTMPDIR=/some/path
 ```
 
 
@@ -210,4 +203,4 @@ console.log(process.memoryUsage());
 
 
 ## 🔐 License
-There are two licenses for the code and data. See the [LICENSE](LICENSE) file for details.
+There are two licenses for the code and data. See the [LICENSE](LICENSE) file for details.

fsWatcher.js

@@ -1,76 +1,44 @@
-// ============================================================================
-// File System Watcher for Auto-Reloading GeoIP Data
-// ============================================================================
-
 const { access, constants, watch } = require('node:fs');
 const { join } = require('node:path');
 const FSWatcher = {};
 
-// ============================================================================
-// Watcher Management
-// ============================================================================
-
-/**
- * Takes an FSWatcher object and closes it.
- * @param {string} name - The name of the watcher to close.
- */
 const stopWatching = name => {
-	const watcher = FSWatcher[name];
-	if (!watcher) return;
+	const watchState = FSWatcher[name];
+	if (!watchState) return;
+
+	if (watchState.cdId !== null) {
+		clearTimeout(watchState.cdId);
+		watchState.cdId = null;
+	}
 
-	watcher.close();
+	watchState.watcher.close();
 	delete FSWatcher[name];
 };
 
-// ============================================================================
-// File System Watch with Debounce
-// ============================================================================
-
-/**
- * Takes a directory/file and watch for change. Upon change, call the callback.
- *
- * @param {String} name - name of this watcher
- * @param {String} directory - path to the directory to watch
- * @param {String} [filename] - (optional) specific filename to watch for, watches for all files in the directory if unspecified
- * @param {Number} cdDelay - delay to wait before triggering the callback
- * @param {Function} callback - function() - called when changes are detected
- */
 const makeFsWatchFilter = (name, directory, filename, cdDelay, callback) => {
-	let cdId = null;
-
-	// Delete the cdId and callback the outer function
-	function timeoutCallback() {
-		cdId = null;
+	const watchState = { watcher: null, cdId: null };
+	const timeoutCallback = () => {
+		watchState.cdId = null;
 		callback();
-	}
-
-	// This function is called when there is a change in the data directory
-	// It sets a timer to wait for the change to be completed
-	function onWatchEvent(event, changedFile) {
-		// Check to make sure changedFile is not null
+	};
+	const onWatchEvent = (_event, changedFile) => {
 		if (!changedFile) return;
 
 		const filePath = join(directory, changedFile);
 		if (!filename || filename === changedFile) {
 			access(filePath, constants.F_OK, err => {
-				if (err) return console.error(err);
-
-				// At this point, a new file system activity has been detected,
-				// We have to wait for file transfer to be finished before moving on.
-
-				// If a cdId already exists, we delete it
-				if (cdId !== null) {
-					clearTimeout(cdId);
-					cdId = null;
+				if (err) {
+					if (err.code !== 'ENOENT') console.error(err);
+					return;
 				}
-
-				// Once the cdDelay has passed, the timeoutCallback function will be called
-				cdId = setTimeout(timeoutCallback, cdDelay);
+				if (watchState.cdId !== null) {
+					clearTimeout(watchState.cdId);
+					watchState.cdId = null;
+				}
+				watchState.cdId = setTimeout(timeoutCallback, cdDelay);
 			});
 		}
-	}
-
-	// Manage the case where filename is missing (because it's optional)
+	};
 	if (typeof cdDelay === 'function') {
 		callback = cdDelay;
 		cdDelay = filename;
@@ -81,11 +49,9 @@ const makeFsWatchFilter = (name, directory, filename, cdDelay, callback) => {
 		stopWatching(name);
 	}
 
-	FSWatcher[name] = watch(directory, onWatchEvent);
+	watchState.watcher = watch(directory, onWatchEvent);
+	FSWatcher[name] = watchState;
 };
 
-// ============================================================================
-// Exports
-// ============================================================================
-
 module.exports = { makeFsWatchFilter, stopWatching };
+

index.d.ts

@@ -11,7 +11,6 @@ interface GeoIp2Location {
 }
 
 export function lookup(ip: string | number): GeoIp2Location | null;
-export function pretty(n: string | number | any[]): string;
 export function reloadDataSync(): void;
 export function reloadData(callback: (err?: Error | null) => void): void;
 export function reloadData(): Promise<void>;