sindresorhus

szmarczak

cacheable-lookup

A cacheable dns.lookup(…) that respects the TTL

import {Resolver, promises as dnsPromises, lookup} from 'dns';

type AsyncResolver = dnsPromises.Resolver;

	set(hostname: string, entries: EntryObject[], ttl: number): TPromise<void | boolean | this>;

	get(hostname: string): TPromise<EntryObject[] | undefined>;

	delete(hostname: string): TPromise<boolean>;

	 * Custom cache instance. If `undefined`, it will create a new one.

	 * Limits the cache time (TTL). If set to `0`, it will make a new DNS query each time.

	 * DNS Resolver used to make DNS queries.

	 * When the DNS server responds with `ENOTFOUND` or `ENODATA` and the OS reports that the entry is available,

	 * it will use `dns.lookup(...)` directly for the requested hostnames for the specified amount of time (in seconds).

	 * If you don't query internal hostnames (such as `localhost`, `database.local` etc.),

	 * it is strongly recommended to set this value to `0`.

	 * The time how long it needs to remember failed queries (TTL in seconds).

	 * **Note**: This option is independent, `options.maxTtl` does not affect this.

	 * The fallback function to use when the DNS server responds with `ENOTFOUND` or `ENODATA`.

	 * **Note**: This has no effect if the `fallbackDuration` option is less than `1`.

	 * The IP address (can be an IPv4 or IPv5 address).

	 * One or more supported getaddrinfo flags. Multiple flags may be passed by bitwise ORing their values.

	 * The record family. Must be `4` or `6`. IPv4 and IPv6 addresses are both returned by default.

	 * When `true`, the callback returns all resolved addresses in an array. Otherwise, returns a single address.

	 * The DNS servers used to make queries. Can be overridden - doing so will clear the cache.

	 * @see https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback

	lookup(hostname: string, family: IPFamily, callback: (error: NodeJS.ErrnoException, address: string, family: IPFamily) => void): void;

	lookup(hostname: string, callback: (error: NodeJS.ErrnoException, address: string, family: IPFamily) => void): void;

	lookup(hostname: string, options: LookupOptions & {all: true}, callback: (error: NodeJS.ErrnoException, result: ReadonlyArray<EntryObject>) => void): void;

	lookup(hostname: string, options: LookupOptions, callback: (error: NodeJS.ErrnoException, address: string, family: IPFamily) => void): void;

	lookup(hostname: string, family: IPFamily, callback: (error: NodeJS.ErrnoException | null, address: string, family: IPFamily) => void): void;

	lookup(hostname: string, callback: (error: NodeJS.ErrnoException | null, address: string, family: IPFamily) => void): void;

	lookup(hostname: string, options: LookupOptions & {all: true}, callback: (error: NodeJS.ErrnoException | null, result: ReadonlyArray<EntryObject>) => void): void;

	lookup(hostname: string, options: LookupOptions, callback: (error: NodeJS.ErrnoException | null, address: string, family: IPFamily) => void): void;

	 * The asynchronous version of `dns.lookup(…)`.

	lookupAsync(hostname: string, options: LookupOptions & {all: true}): Promise<ReadonlyArray<EntryObject>>;

	lookupAsync(hostname: string, options: LookupOptions): Promise<EntryObject>;

	lookupAsync(hostname: string): Promise<EntryObject>;

	lookupAsync(hostname: string, family: IPFamily): Promise<EntryObject>;

	 * An asynchronous function which returns cached DNS lookup entries. This is the base for `lookupAsync(hostname, options)` and `lookup(hostname, options, callback)`.

	query(hostname: string): Promise<ReadonlyArray<EntryObject>>;

	 * An asynchronous function which makes a new DNS lookup query and updates the database. This is used by `query(hostname, family)` if no entry in the database is present. Returns an array of objects with `address`, `family`, `ttl` and `expires` properties.

	queryAndCache(hostname: string): Promise<ReadonlyArray<EntryObject>>;

	 * Attaches itself to an Agent instance.

	 * Removes itself from an Agent instance.

	 * Updates interface info. For example, you need to run this when you plug or unplug your WiFi driver.

	 * **Note:** Running `updateInterfaceInfo()` will trigger `clear()` only on network interface removal.

	 * Clears the cache for the given hostname. If the hostname argument is not present, the entire cache will be emptied.

  "description": "A cacheable dns.lookup(…) that respects the TTL",

    "test": "xo && nyc --reporter=lcovonly --reporter=text ava && tsd"

    "url": "git+https://github.com/szmarczak/cacheable-lookup.git"

    "url": "https://github.com/szmarczak/cacheable-lookup/issues"

  "homepage": "https://github.com/szmarczak/cacheable-lookup#readme",

		{
		"name": "cacheable-lookup",
		"version": "6.0.0",
		"version": "6.0.1",
		"description": "A cacheable dns.lookup(…) that respects the TTL",
		@@ -5,0 +5,0 @@ "engines": {

		@@ -102,6 +102,6 @@ import {Resolver, promises as dnsPromises, lookup} from 'dns';
		*/
		lookup(hostname: string, family: IPFamily, callback: (error: NodeJS.ErrnoException, address: string, family: IPFamily) => void): void;
		lookup(hostname: string, callback: (error: NodeJS.ErrnoException, address: string, family: IPFamily) => void): void;
		lookup(hostname: string, options: LookupOptions & {all: true}, callback: (error: NodeJS.ErrnoException, result: ReadonlyArray<EntryObject>) => void): void;
		lookup(hostname: string, options: LookupOptions, callback: (error: NodeJS.ErrnoException, address: string, family: IPFamily) => void): void;
		lookup(hostname: string, family: IPFamily, callback: (error: NodeJS.ErrnoException \| null, address: string, family: IPFamily) => void): void;
		lookup(hostname: string, callback: (error: NodeJS.ErrnoException \| null, address: string, family: IPFamily) => void): void;
		lookup(hostname: string, options: LookupOptions & {all: true}, callback: (error: NodeJS.ErrnoException \| null, result: ReadonlyArray<EntryObject>) => void): void;
		lookup(hostname: string, options: LookupOptions, callback: (error: NodeJS.ErrnoException \| null, address: string, family: IPFamily) => void): void;
		/**
		@@ -108,0 +108,0 @@ * The asynchronous version of `dns.lookup(…)`.

Improved metrics