my-idlers/node_modules/cacheable-lookup/index.d.ts
cp6 fd22b0bf58 V2 (Laravel re-make)
V2 (Laravel re-make)
2022-03-06 02:02:12 +11:00

140 lines
4.8 KiB
TypeScript

import {Resolver, promises as dnsPromises, lookup} from 'dns';
import {Agent} from 'http';
type AsyncResolver = dnsPromises.Resolver;
export type IPFamily = 4 | 6;
type TPromise<T> = T | Promise<T>;
export interface CacheInstance {
set(hostname: string, entries: EntryObject[], ttl: number): TPromise<void | boolean | this>;
get(hostname: string): TPromise<EntryObject[] | undefined>;
delete(hostname: string): TPromise<boolean>;
clear(): TPromise<void>;
}
export interface Options {
/**
* Custom cache instance. If `undefined`, it will create a new one.
* @default undefined
*/
cache?: CacheInstance;
/**
* Limits the cache time (TTL). If set to `0`, it will make a new DNS query each time.
* @default Infinity
*/
maxTtl?: number;
/**
* DNS Resolver used to make DNS queries.
* @default new dns.promises.Resolver()
*/
resolver?: Resolver | AsyncResolver;
/**
* 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`.
* @default 3600
*/
fallbackDuration?: number;
/**
* The time how long it needs to remember failed queries (TTL in seconds).
*
* **Note**: This option is independent, `options.maxTtl` does not affect this.
* @default 0.15
*/
errorTtl?: number;
/**
* 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`.
* @default dns.lookup
*/
lookup?: typeof lookup;
}
export interface EntryObject {
/**
* The IP address (can be an IPv4 or IPv5 address).
*/
readonly address: string;
/**
* The IP family.
*/
readonly family: IPFamily;
/**
* The original TTL.
*/
readonly ttl?: number;
/**
* The expiration timestamp.
*/
readonly expires?: number;
}
export interface LookupOptions {
/**
* One or more supported getaddrinfo flags. Multiple flags may be passed by bitwise ORing their values.
*/
hints?: number;
/**
* The record family. Must be `4` or `6`. IPv4 and IPv6 addresses are both returned by default.
*/
family?: IPFamily;
/**
* When `true`, the callback returns all resolved addresses in an array. Otherwise, returns a single address.
* @default false
*/
all?: boolean;
}
export default class CacheableLookup {
constructor(options?: Options);
/**
* The DNS servers used to make queries. Can be overridden - doing so will clear the cache.
*/
servers: string[];
/**
* @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;
/**
* 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.
*/
install(agent: Agent): void;
/**
* Removes itself from an Agent instance.
*/
uninstall(agent: Agent): void;
/**
* 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.
*/
updateInterfaceInfo(): void;
/**
* Clears the cache for the given hostname. If the hostname argument is not present, the entire cache will be emptied.
*/
clear(hostname?: string): void;
}