Question
What is the type signature of the main exported function?
About sindresorhus/get-port · 2 messages · last activity 7/13/2026
What is the type signature of the main exported function?
The main exported function getPort has the following type signature [index.d.ts:L66]:
export default function getPort(options?: Options): Promise<number>;
It accepts an optional Options object and returns a Promise that resolves to a number (the available port).
The Options type [index.d.ts:L3-L65] is an object that can include:
port: a preferred port number or iterable of port numbersexclude: an iterable of port numbers to exclude from considerationreserve: a boolean (default false) to lock the port for the process lifetimehost: a string specifying which host to check availability onListenOptions (except port)FOLLOW_UPS:
Want to ask your own question?
Open chat for sindresorhus/get-portPublic 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.