feat: portRange support

also defaulting range to 3000...3100

README.md

@@ -41,6 +41,7 @@ interface GetPortOptions {
 
   random?: boolean
   port?: number
+  portRange?: [from: number, to: number]
   ports?: number[]
   host?: string
 
@@ -63,7 +64,11 @@ First port to check. Default is `process.env.PORT || 3000`
 
 ### `ports`
 
-Alternative ports to check. Default is `[4000, 5000, 7000, 8000]`
+Alternative ports to check.
+
+### `portRange`
+
+Alternative port range to check. Deefault is `[3000,3100]`
 
 ### `host`
 

src/index.ts

@@ -10,6 +10,7 @@ export interface GetPortOptions {
   random: boolean
   port: number
   ports: number[]
+  portRange: [from: number, to: number]
   host: string
   memoDir: string
   memoName: string
@@ -29,7 +30,8 @@ export async function getPort (config?: GetPortInput): Promise<PortNumber> {
     name: 'default',
     random: false,
     port: parseInt(process.env.PORT || '') || 3000,
-    ports: [4000, 5000, 7000, 8000],
+    ports: [],
+    portRange: [3000, 3100],
     host: undefined,
     memoName: 'port',
     ...config
@@ -40,9 +42,11 @@ export async function getPort (config?: GetPortInput): Promise<PortNumber> {
   }
 
   // Ports to check
+
   const portsToCheck: PortNumber[] = [
     options.port,
-    ...options.ports
+    ...options.ports,
+    ...generateRange(options.portRange[0], options.portRange[1])
   ].filter(port => port && isSafePort(port))
 
   // Memo
@@ -108,6 +112,17 @@ export async function checkPort (port: PortNumber, host: HostAddress | HostAddre
 
 // ----- Internal -----
 
+function generateRange (from: number, to: number): number[] {
+  if (to < from) {
+    return []
+  }
+  const r = []
+  for (let i = from; i < to; i++) {
+    r.push(i)
+  }
+  return r
+}
+
 function _checkPort (port: PortNumber, host: HostAddress): Promise<PortNumber|false> {
   return new Promise((resolve) => {
     const server = createServer()

test/index.test.ts

@@ -19,7 +19,7 @@ describe('getPort ()', () => {
     test('default port is in use', async () => {
       portBlocker = await blockPort(3000)
       const port = await getPort()
-      expect(port).toEqual(4000)
+      expect(port).toEqual(3001)
     })
   })
 })
@@ -40,7 +40,7 @@ describe('getPort (host)', () => {
     test('default port is IN USE', async () => {
       portBlocker = await blockPort(3000, 'localhost')
       const port = await getPort({ host: 'localhost' })
-      expect(port).toEqual(4000)
+      expect(port).toEqual(3001)
     })
   })
 })
@@ -56,6 +56,6 @@ describe('getPort (host)', () => {
     process.env.HOST = 'localhost'
     portBlocker = await blockPort(3000, 'localhost')
     const port = await getPort()
-    expect(port).toEqual(4000)
+    expect(port).toEqual(3001)
   })
 })