cacheable-lookup
Advanced tools
Package description
The cacheable-lookup npm package is designed to enhance the Node.js DNS module with caching capabilities. It provides a way to cache DNS lookup results in order to improve performance for repeated DNS queries. This is particularly useful for applications making numerous requests to the same domains, as it reduces the number of DNS queries that need to be performed over the network.
Caching DNS lookups
This feature allows you to cache DNS lookups to improve performance. The code sample demonstrates how to perform a DNS lookup for 'example.com' and cache the result.
const CacheableLookup = require('cacheable-lookup');
const cacheable = new CacheableLookup();
cacheable.lookup('example.com', (err, address, family) => {
console.log(address);
});Integration with http.Agent
This feature demonstrates how cacheable-lookup can be integrated with Node.js http.Agent to automatically use cached DNS lookups for HTTP requests. This can significantly reduce DNS lookup times for repeated requests to the same domain.
const CacheableLookup = require('cacheable-lookup');
const http = require('http');
const cacheable = new CacheableLookup();
const agent = new http.Agent({
lookup: cacheable.lookup
});
http.get('http://example.com', { agent }, (res) => {
// Handle response
});dns-cache is a simple DNS cache module. It provides basic caching functionalities similar to cacheable-lookup but lacks some of the advanced features and customizability options such as integration with http.Agent.
node-dns-cache offers DNS caching capabilities to Node.js applications. While it serves a similar purpose to cacheable-lookup, it might not offer the same level of performance optimizations and ease of integration with existing Node.js networking components.
Readme
A cacheable
dns.lookup(…)that respects TTL :tada:
Making lots of HTTP requests? You can save some time by caching DNS lookups :zap:
lookup optionconst http = require('http');
const CacheableLookup = require('cacheable-lookup');
const cacheable = new CacheableLookup();
http.get('https://example.com', {lookup: cacheable.lookup}, response => {
// Handle the response here
});
const http = require('http');
const CacheableLookup = require('cacheable-lookup');
const cacheable = new CacheableLookup();
cacheable.install(http.globalAgent);
http.get('https://example.com', response => {
// Handle the response here
});
Returns a new instance of CacheableLookup.
Type: Map | Keyv
Default: new Map()
Custom cache instance. If undefined, it will create a new one.
Note: If you decide to use Keyv instead of the native implementation, the performance will drop by 10x. Memory leaks may occur as it doesn't provide any way to remove all the deprecated values at once.
Type: object
Default: {}
Options used to cache the DNS lookups.
Type: number
Default: Infinity
The maximum lifetime of the entries received from the specifed DNS server (TTL in seconds).
If set to 0, it will make a new DNS query each time.
Pro Tip: This shouldn't be lower than your DNS server response time in order to prevent bottlenecks. For example, if you use Cloudflare, this value should be greater than 0.01.
Type: number
Default: 1
The lifetime of the entries received from the OS (TTL in seconds).
Note: This option is independent, options.maxTtl does not affect this.
Pro Tip: This shouldn't be lower than your DNS server response time in order to prevent bottlenecks. For example, if you use Cloudflare, this value should be greater than 0.01.
Type: number
Default: 0.15
The time how long it needs to remember queries that threw ENOTFOUND (TTL in seconds).
Note: This option is independent, options.maxTtl does not affect this.
Pro Tip: This shouldn't be lower than your DNS server response time in order to prevent bottlenecks. For example, if you use Cloudflare, this value should be greater than 0.01.
Type: dns.Resolver | dns.promises.Resolver
Default: new dns.promises.Resolver()
An instance of DNS Resolver used to make DNS queries.
Type: string
Default: undefined (OS-specific)
The full path to the hosts file. Set this to false to prevent loading entries from the hosts file.
Type: object
Type: string
The IP address (can be an IPv4 or IPv6 address).
Type: number
The IP family (4 or 6).
Type: number
Note: This is not present when using the native dns.lookup(...)!
The timestamp (Date.now() + ttl * 1000) when the entry expires.
Note: This is not present when using the native dns.lookup(...)!
The time in seconds for its lifetime.
When options.all is false, then callback(error, address, family, expires, ttl) is called.
When options.all is true, then callback(error, entries) is called.
Type: Array
The DNS servers used to make queries. Can be overridden - doing so will trigger cacheableLookup.updateInterfaceInfo().
The asynchronous version of dns.lookup(…).
Returns an entry object.
If options.all is true, returns an array of entry objects.
Note: If entry(ies) were not found, it will return undefined by default.
Type: string
Type: object
The same as the dns.lookup(…) options.
An asynchronous function which returns cached DNS lookup entries.
This is the base for lookupAsync(hostname, options) and lookup(hostname, options, callback).
Note: This function has no options.
Returns an array of objects with address, family, ttl and expires properties.
An asynchronous function which makes two DNS queries: A and AAAA. The result is cached.
This is used by query(hostname) if no entry in the database is present.
Returns an array of objects with address, family, ttl and expires properties.
Removes outdated entries. It's automatically called on every lookup.
Updates interface info. For example, you need to run this when you plug or unplug your WiFi driver.
Note: Running updateInterfaceInfo() will also trigger clear()!
Clears the cache for the given hostname. If the hostname argument is not present, the entire cache will be cleared.
Performed on:
example.comCacheableLookup#lookupAsync x 2,441,577 ops/sec ±0.57% (87 runs sampled)
CacheableLookup#lookupAsync.all x 2,539,120 ops/sec ±0.48% (88 runs sampled)
CacheableLookup#lookupAsync.all.ADDRCONFIG x 2,228,416 ops/sec ±0.31% (88 runs sampled)
CacheableLookup#lookup x 2,374,110 ops/sec ±0.29% (89 runs sampled)
CacheableLookup#lookup.all x 2,311,587 ops/sec ±0.38% (88 runs sampled)
CacheableLookup#lookup.all.ADDRCONFIG x 2,074,475 ops/sec ±0.41% (90 runs sampled)
dns#lookup x 7,272 ops/sec ±0.36% (86 runs sampled)
dns#lookup.all x 7,249 ops/sec ±0.40% (86 runs sampled)
dns#lookup.all.ADDRCONFIG x 5,693 ops/sec ±0.28% (85 runs sampled)
Fastest is CacheableLookup#lookupAsync.all
The package is based on dns.resolve4(…) and dns.resolve6(…).
It is not possible to use
dns.lookup(…)because underlying calls like getaddrinfo have no concept of servers or TTL (caching is done on OS level instead).
MIT
FAQs
A cacheable dns.lookup(…) that respects TTL
We found that cacheable-lookup demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.