Get an available TCP or UDP port for the given IP address.
const freePort = require('free-port');
freePort()
.then(port =>
{
console.log(port);
//=> 34323
});
Optionally, provide the TCP/IP protocol family type, IP address and/or port:
freePort({ type: 'tcp', ip: '10.10.10.1', port: 8000 })
.then(port =>
{
console.log(port);
//=> 8000 if the given port if free to use, otherwise the corresponding exception is thrown
});
Returns a Promise for a port number.
Type: Object
Type: string
TCP/IP family type. Options for this parameter are 'udp' and 'tcp'. Default value is 'udp'.
Type: number
Specific port to be checked. Default value is 0, which means that any free port can be taken.
Type: string
The IP address for which a free port is requested. IPv4 and IPv6 addressing is supported. Default value is '127.0.0.1'.
FAQs
Get a free TCP or UDP port for the given IP address
The npm package pick-port receives a total of 3,287 weekly downloads. As such, pick-port popularity was classified as popular.
We found that pick-port demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.