index.d.ts 425 B

123456789101112131415161718
  1. export interface Options {
  2. /**
  3. * A preferred port or an array of preferred ports to use.
  4. */
  5. readonly port?: number | ReadonlyArray<number>,
  6. /**
  7. * The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.
  8. */
  9. readonly host?: string;
  10. }
  11. /**
  12. * Get an available TCP port number.
  13. *
  14. * @returns Port number.
  15. */
  16. export default function getPort(options?: Options): Promise<number>;