Merge pull request #81 from adzhiljano/fix_missing_regexp_type

fix: add missing regexp type when passing regexp as value

Author: yibn2008

README.md

@@ -117,7 +117,7 @@ function find(type: 'port' | 'pid' | 'name', value: string | number, options?: F
 - `type` - The type of search, supports: `'port' | 'pid' | 'name'`
 - `value` - The value to search for. Can be RegExp if type is `'name'`
 - `options` - Optional configuration object or boolean for strict mode
-  - `options.strict` - Optional strict mode for exact matching of port, pid, or name (on Windows, `.exe` can be omitted)
+  - `options.strict` - Optional strict mode for exact matching of name (on Windows, `.exe` can be omitted)
   - `options.logLevel` - Set logging level to `'trace' | 'debug' | 'info' | 'warn' | 'error'`. Useful for silencing netstat warnings on Linux
   - `options.skipSelf` - Skip the current process when searching by name
 

src/find.ts

@@ -26,7 +26,7 @@ const findBy = {
       skipSelf: true
     })
   }
-} as Record<FindMethod, (value: string | number, config: FindConfig) => Promise<ProcessInfo[]>>
+} as Record<FindMethod, (value: string | RegExp | number, config: FindConfig) => Promise<ProcessInfo[]>>
 
 /**
  * find process by condition
@@ -47,12 +47,18 @@ const findBy = {
  * @param {Boolean|Option}
  * @return {Promise}
  */
-function find(by: FindMethod, value: string | number, options?: FindConfig | boolean): Promise<ProcessInfo[]> {
+function find(by: FindMethod, value: string | RegExp | number, options?: FindConfig | boolean): Promise<ProcessInfo[]> {
   const config: FindConfig = Object.assign({
     logLevel: 'warn' as const,
     strict: typeof options === 'boolean' ? options : false
   }, typeof options === 'object' ? options : {})
 
+  // strict is applicable only when finding by name and the value is a string,
+  // in all other cases whatever is passed is overwritten to false
+  if (by !== 'name' || typeof value !== 'string') {
+    config.strict = false;
+  }
+
   if (config.logLevel) {
     log.setLevel(config.logLevel)
   }
@@ -67,7 +73,7 @@ function find(by: FindMethod, value: string | number, options?: FindConfig | boo
       } else if (by === 'port' && !isNumber) {
         reject(new Error('port must be a number'))
       } else {
-        findBy[by](value as any, config).then(resolve, reject)
+        findBy[by](value, config).then(resolve, reject)
       }
     }
   })

src/find_process.ts

@@ -2,7 +2,7 @@ import * as path from 'path'
 import utils from './utils'
 import { ProcessInfo, FindCondition, PlatformFinder } from './types'
 
-function matchName(text: string, name: string): boolean {
+function matchName(text: string, name: string | RegExp): boolean {
   if (!name) {
     return true
   }

src/types.ts

@@ -25,7 +25,7 @@ export interface FindConfig {
  */
 export interface FindCondition {
   pid?: number
-  name?: string
+  name?: string | RegExp
   config: FindConfig
   skipSelf?: boolean
 }

test/find.test.ts

@@ -72,6 +72,24 @@ describe('Find process test', function () {
       });
   })
 
+    it('should find process list matched given regexp', function (done) {
+    const file = path.join(__dirname, 'fixtures/child_process.js')
+    const cps: ChildProcessWithoutNullStreams = cp.spawn(process.execPath, [file, 'AAABBBCCC']);
+
+    (find as any)('name', /A{2,3}B{2,3}C{2,3}/gi)
+      .then(function (list: any[]) {
+        cps.kill()
+
+        assert(list.length === 1)
+        assert.equal(cps.pid, list[0].pid)
+        done()
+      }, function (err: any) {
+        cps.kill()
+
+        done(err)
+      })
+  })
+
   it('should resolve empty array when pid not exists', function (done) {
     (find as any)('port', 100000)
       .then(function (list: any[]) {