get-port-please
Advanced tools
Package description
The `get-port-please` npm package is designed to help developers find an available port on the host machine. It is particularly useful in scenarios where an application needs to start a server but must avoid port conflicts with other applications. This package offers flexibility in selecting ports, including the ability to specify preferred port ranges or fallback to any available port if the preferred ones are occupied.
Getting an available port
This feature allows you to get an available port on the machine. If no arguments are passed, it returns any available port.
const getPort = require('get-port-please');
getPort().then(port => {
console.log(`Available port: ${port}`);
});Specifying preferred ports
This feature enables specifying an array of preferred ports. The function will return the first available port from the specified list or any available port if none from the list are free.
const getPort = require('get-port-please');
getPort({ preferredPorts: [3000, 3001, 3002] }).then(port => {
console.log(`Available port: ${port}`);
});Specifying port ranges
This feature allows specifying ranges of ports to check for availability. It's useful when you need a port within a specific range.
const getPort = require('get-port-please');
getPort({ portRanges: [{ from: 8000, to: 8005 }] }).then(port => {
console.log(`Available port within range: ${port}`);
});Similar to `get-port-please`, `portfinder` provides a way to get an available port on the host machine. However, `portfinder` focuses more on finding an open port by incrementing from a base port, rather than specifying preferred ports or ranges.
The `get-port` package also helps in finding an available port. While it shares similar basic functionality with `get-port-please`, it does not offer the same level of control over specifying port ranges or preferred port lists.
Readme
Get an available TCP port to listen
Install package:
yarn add get-port-please
# or
npm install get-port-please
// ESM
import { getPort, checkPort, getRandomPort, waitForPort } from 'get-port-please'
// CommonJS
const { getPort, checkPort, getRandomPort, waitForPort } = require('get-port-please')
getPort(options?: GetPortOptions): Promise<number>
checkPort(port: number, host?: string): Promise<number | false>
waitForPort(port: number, options): Promise<number | false>
Try sequence is: port > ports > memo > random
interface GetPortOptions {
name?: string
random?: boolean
port?: number
portRange?: [from: number, to: number]
ports?: number[]
host?: string
memoDir?: string
memoName?: string
}
nameUnique name for port memorizing. Default is default.
randomIf enabled, port and ports will be ignored. Default is false.
portFirst port to check. Default is process.env.PORT || 3000
portsAlternative ports to check.
portRangeAlternative port range to check. Default is [3000, 3100]
hostThe host to check. Default is process.env.HOST otherwise all available hosts will be checked.
memoDir / memoNameOptions passed to fs-memo
node_modules/get-port/dist.get-portMIT
FAQs
Get an available TCP port to listen
We found that get-port-please demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer 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
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.