From 8bb6f0dc903b45e0a418dc9eab7e30e4654a4f2b Mon Sep 17 00:00:00 2001 From: Ivan Medina Date: Sun, 3 May 2020 08:38:50 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Merge=20PR=20#44439=20[detect-po?= =?UTF-8?q?rt]:=20add=20PortConfig=20type=20for=20first=20argument=20from?= =?UTF-8?q?=20default=20function=20by=20@ivandevp?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add portconfig type for detect port first argument * Update detect-port version * Fix version format * Remove autogenerated bin --- types/detect-port/detect-port-tests.ts | 21 ++++++++++++++------- types/detect-port/index.d.ts | 15 ++++++++++++--- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/types/detect-port/detect-port-tests.ts b/types/detect-port/detect-port-tests.ts index afd532ead0..d399c1cf16 100644 --- a/types/detect-port/detect-port-tests.ts +++ b/types/detect-port/detect-port-tests.ts @@ -1,12 +1,12 @@ -import * as detect from "detect-port"; +import * as detect from 'detect-port'; const port = 8000; +const hostname = 'localhost'; /** * callback usage */ -detect(port, (err: Error, _port: number) => { -}); +detect(port, (err: Error, _port: number) => {}); function* yieldSyntax() { const _port: number = yield detect(port); @@ -16,7 +16,14 @@ function* yieldSyntax() { * use as a promise */ detect(port) - .then((_port: number) => { - }) - .catch(err => { - }); + .then((_port: number) => {}) + .catch(err => {}); + +/** + * port config usage + */ +detect({ port, hostname, callback: (err: Error, _port: number) => {} }); + +detect({ port, hostname }) + .then((_port: number) => {}) + .catch(err => {}); diff --git a/types/detect-port/index.d.ts b/types/detect-port/index.d.ts index a0fa185ece..cf224d2984 100644 --- a/types/detect-port/index.d.ts +++ b/types/detect-port/index.d.ts @@ -1,11 +1,20 @@ -// Type definitions for detect-port 1.1 +// Type definitions for detect-port 1.3 // Project: https://github.com/node-modules/detect-port // Definitions by: François Nguyen +// Ivan Medina // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +type DetectPortCallback = (err: Error, _port: number) => void; + +interface PortConfig { + port: number; + hostname?: string; + callback?: DetectPortCallback; +} + interface DetectPort { - (port: number, callback: (err: Error, _port: number) => void): void; - (port: number): Promise; + (port: number | PortConfig, callback: DetectPortCallback): void; + (port: number | PortConfig): Promise; } declare const detectPort: DetectPort; export = detectPort;