Blame view

node_modules/portfinder/lib/portfinder.d.ts 1.06 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
  /**
   * portfinder.js typescript definitions.
   *
   * (C) 2011, Charlie Robbins
   */
  
  type PortfinderCallback = (err: Error, port: number) => void;
  
  interface PortFinderOptions{
    /**
     * Host to find available port on.
     */
    host?: string;
    /**
     * search start port (equals to port when not provided)
     * This exists because getPort and getPortPromise mutates port state in
     * recursive calls and doesn't have a way to retrieve begininng port while
     * searching.
     */
    startPort?: number;
    /**
     * Minimum port (takes precedence over `basePort`).
     */
    port?: number;
    /**
     * Maximum port
     */
    stopPort?: number;
  }
  
  /**
   * The lowest port to begin any port search from.
   */
  export let basePort: number;
  
  /**
   * Responds with a unbound port on the current machine.
   */
  export function getPort(callback: PortfinderCallback): void;
  export function getPort(options: PortFinderOptions, callback: PortfinderCallback): void;
  /**
   * Responds a promise of an unbound port on the current machine.
   */
  export function getPortPromise(options?: PortFinderOptions): Promise<number>;