RepoPilot

What is the type signature of the main exported function?

About sindresorhus/get-port · 2 messages · last activity 5/18/2026

Question

What is the type signature of the main exported function?

RepoPilot

The main exported function getPort has the following type signature [index.d.ts:L66]:

export default function getPort(options?: Options): Promise<number>;

This function:

  • Accepts an optional Options parameter
  • Returns a Promise that resolves to a number (the available TCP port)

The Options type is defined in [index.d.ts:L3-L65] and includes several optional properties:

  • port: A preferred port or iterable of preferred ports
  • exclude: Ports that should not be returned
  • reserve: Whether to lock the port for the process lifetime (default: false)
  • host: The specific host to check port availability on

FOLLOW_UPS:

  • What does the reserve option do exactly?
  • How does the exclude option work?
  • Can you show an example with multiple preferred ports?

Want to ask your own question?

Open chat for sindresorhus/get-port

Public Q&A. Generated by RepoPilot from the actual source of sindresorhus/get-port. AI answers can be incomplete or stale — verify before relying on them.