Skip to content

Commit 8bb6f0d

Browse files
authored
🤖 Merge PR DefinitelyTyped#44439 [detect-port]: add PortConfig type for first argument from default function by @ivandevp
* Add portconfig type for detect port first argument * Update detect-port version * Fix version format * Remove autogenerated bin
1 parent 0d04fc9 commit 8bb6f0d

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed
Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
import * as detect from "detect-port";
1+
import * as detect from 'detect-port';
22

33
const port = 8000;
4+
const hostname = 'localhost';
45

56
/**
67
* callback usage
78
*/
8-
detect(port, (err: Error, _port: number) => {
9-
});
9+
detect(port, (err: Error, _port: number) => {});
1010

1111
function* yieldSyntax() {
1212
const _port: number = yield detect(port);
@@ -16,7 +16,14 @@ function* yieldSyntax() {
1616
* use as a promise
1717
*/
1818
detect(port)
19-
.then((_port: number) => {
20-
})
21-
.catch(err => {
22-
});
19+
.then((_port: number) => {})
20+
.catch(err => {});
21+
22+
/**
23+
* port config usage
24+
*/
25+
detect({ port, hostname, callback: (err: Error, _port: number) => {} });
26+
27+
detect({ port, hostname })
28+
.then((_port: number) => {})
29+
.catch(err => {});
Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
// Type definitions for detect-port 1.1
1+
// Type definitions for detect-port 1.3
22
// Project: https://github.com/node-modules/detect-port
33
// Definitions by: François Nguyen <https://github.com/lith-light-g>
4+
// Ivan Medina <https://github.com/ivandevp>
45
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
56

7+
type DetectPortCallback = (err: Error, _port: number) => void;
8+
9+
interface PortConfig {
10+
port: number;
11+
hostname?: string;
12+
callback?: DetectPortCallback;
13+
}
14+
615
interface DetectPort {
7-
(port: number, callback: (err: Error, _port: number) => void): void;
8-
(port: number): Promise<number>;
16+
(port: number | PortConfig, callback: DetectPortCallback): void;
17+
(port: number | PortConfig): Promise<number>;
918
}
1019
declare const detectPort: DetectPort;
1120
export = detectPort;

0 commit comments

Comments
 (0)