get-port

Functions

• clearLockedPorts()
• getPort()
• portNumbers()

Type Aliases

• Options

function clearLockedPorts

clearLockedPorts: () => void;

• Clear the internal cache of locked ports, including any ports locked with the option.

  This can be useful when you want the results to be unaffected by previous calls.

  Please note that clearing the cache removes protection against [in-process race conditions](https://github.com/sindresorhus/get-port#beware).

  Example 1

  import getPort, {clearLockedPorts} from 'get-port';
  
  const port = [3000, 3001, 3002];
  
  console.log(await getPort({port}));
  //=> 3000
  
  console.log(await getPort({port}));
  //=> 3001
  
  // If you want the results to be unaffected by previous calls, clear the cache.
  clearLockedPorts();
  
  console.log(await getPort({port}));
  //=> 3000

function getPort

getPort: (options?: Options) => Promise<number>;

• Get an available TCP port number.

  Returns

  Port number.

  Example 1

  import getPort from 'get-port';
  
  console.log(await getPort());
  //=> 51402
  
  // Pass in a preferred port
  console.log(await getPort({port: 3000}));
  // Will use 3000 if available, otherwise fall back to a random port
  
  // Pass in an array of preferred ports
  console.log(await getPort({port: [3000, 3001, 3002]}));
  // Will use any element in the preferred ports array if available, otherwise fall back to a random port

function portNumbers

portNumbers: (from: number, to: number) => Iterable<number>;

• Generate port numbers in the given range from...to.

  Parameter from

  The first port of the range. Must be in the range 1024...65535.

  Parameter to

  The last port of the range. Must be in the range 1024...65535 and must be greater than from.

  Returns

  The port numbers in the range.

  Example 1

  import getPort, {portNumbers} from 'get-port';
  
  console.log(await getPort({port: portNumbers(3000, 3100)}));
  // Will use any port from 3000 to 3100, otherwise fall back to a random port

type Options

type Options = {
    /**
	A preferred port or an iterable of preferred ports to use.
	*/
    readonly port?: number | Iterable<number>;

    /**
	Ports that should not be returned.

	You could, for example, pass it the return value of the `portNumbers()` function.
	*/
    readonly exclude?: Iterable<number>;

    /**
	Reserve the port so that it's locked for the lifetime of the process instead of the default 15-30 seconds.

	This is useful when there is a long delay between getting the port and actually binding to it, such as in long-running test suites.

	Reserved ports are locked globally by port number for the current process, even if you looked them up with a specific `host` or `ipv6Only` option.

	Use {@link clearLockedPorts} to release reserved ports.

	@default false

	@example
	```
	import getPort from 'get-port';

	const port = await getPort({reserve: true});
	// `port` will not be returned again by get-port for the lifetime of the process
	```
	*/
    readonly reserve?: boolean;

    /**
	The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.

	By default, it checks availability on all local addresses defined in [OS network interfaces](https://nodejs.org/api/os.html#os_os_networkinterfaces). If this option is set, it will only check the given host.
	*/
    readonly host?: string;
} & Omit<ListenOptions, 'port'>;