Domainator

Domainator is a minimalisitic node module for extracting the domain name from a given url. It uses the TLD suffix list provided by Mozilla.

• It provides asynchronous calls for handling the same.
• Supports single and batch calls for the same.
• Uses caching strategy for optimising the calls.Usually the first call takes time and all other are just O(1) access from an in memory cache.

Features

• Uses caching strategy for querying domain names.
• Majority of time consumed for cache population. First call is deferred, rest are just cache access operation.
• Supports single and batch calls for querying the domain names.

Usage

Dependencies

Domainator uses a number of node modules to work properly:

• Bluebird - A blazing fast promise library
• Request-promise - promisified request library

Installation

Domainator requires Node.js v6+ to run.

$ npm install domainator

For global install on your machine do

$ npm install -g  domainator

For production environments, the best practice is to require the module on server initialisation, so that cache population is done. Usually, in a medium level latency network, it usually takes about 2 seconds for cache population.

All calls that happen before the cache is populated are deferred. They return as and when the cache population is done. After that all the calls can be assumed to take constant time.

Tests

Mocha tests have been added for maintaining the source integrity. Use the following command to test the validity of the source code and as a proof of correctness of the methods provided by the node module

$ npm test

License

MIT

Free Software, Hell Yeah!