Merge 84aaa66 into 6ed7e37

README.md

@@ -106,6 +106,13 @@ Default: `undefined` (OS-specific)
 
 The full path to the `hosts` file. Set this to `false` to prevent loading entries from the `hosts` file.
 
+##### options.firstEntry
+
+Type: `boolean`<br>
+Default: `false`
+
+If the host resolves to multiple ip's, return only the first one.
+
 ### Entry object
 
 Type: `object`

index.d.ts

@@ -35,6 +35,12 @@ export interface Options {
 	 * @default '/etc/hosts'
 	 */
 	customHostsPath?: string | false;
+	/**
+	 * If the host resolves to multiple ip's, return each time a random ip address.
+	 * Set this to `false` to always return the same ip.
+	 * @default false
+	 */
+	firstEntry: false;
 	/**
 	 * The lifetime of the entries received from the OS (TTL in seconds).
 	 *

index.test-d.ts

@@ -11,6 +11,7 @@ import CacheableLookup, {EntryObject} from '.';
 	new CacheableLookup({
 		cache: new Keyv(),
 		customHostsPath: false,
+		firstEntry: false,
 		fallbackTtl: 0,
 		errorTtl: 0,
 		maxTtl: 0,

source/index.js

@@ -57,6 +57,7 @@ const ttl = {ttl: true};
 class CacheableLookup {
 	constructor({
 		customHostsPath,
+		firstEntry = false,
 		cache = new Map(),
 		maxTtl = Infinity,
 		resolver = new AsyncResolver(),
@@ -66,6 +67,7 @@ class CacheableLookup {
 		this.maxTtl = maxTtl;
 		this.fallbackTtl = fallbackTtl;
 		this.errorTtl = errorTtl;
+		this.firstEntry = firstEntry;
 
 		// This value is in milliseconds
 		this._lockTime = Math.max(Math.floor(Math.min(this.fallbackTtl * 1000, this.errorTtl * 1000)), 10);
@@ -165,7 +167,7 @@ class CacheableLookup {
 			return cached;
 		}
 
-		if (cached.length === 1) {
+		if (cached.length === 1 || this.firstEntry) {
 			return cached[0];
 		}
 

tests/test.js

@@ -256,6 +256,36 @@ test.serial('multiple entries', async t => {
 	Math.random = random;
 });
 
+test.serial('multiple entries when `options.firstEntry` is true, then we always resolve to the first entry', async t => {
+	const cacheable = new CacheableLookup({resolver, customHostsPath: false, firstEntry: true});
+
+	const {random} = Math;
+
+	{
+		// Let's fool the destiny
+		Math.random = () => 0;
+		const entry = await cacheable.lookupAsync('multiple');
+
+		verify(t, entry, {
+			address: '127.0.0.127',
+			family: 4
+		});
+	}
+
+	{
+		// Let's fool the destiny
+		Math.random = () => 0.6;
+		const entry = await cacheable.lookupAsync('multiple');
+
+		verify(t, entry, {
+			address: '127.0.0.127',
+			family: 4
+		});
+	}
+
+	Math.random = random;
+});
+
 test('if `options.all` is falsy, then `options.family` is 4 when not defined', async t => {
 	const cacheable = new CacheableLookup({resolver, customHostsPath: false});