PortFinder

Fast and minimalist port finder!

Index

1. Install it!
2. Run it!
3. Environment variable
4. Additional information

Install it!

npm i @fjrodafo/port-finder

Run it!

// Import the module
const { findAvailablePort } = require('@fjrodafo/port-finder');

// It will find an available port in case port 3000 is busy
findAvailablePort(3000).then(port => {
    server.listen(port, () => {
        console.log(`Server listening on port http://localhost:${port}`);
    });
});

Environment variable

// You can create an environment variable for advanced use
const desiredPort = process.env.PORT ?? 3000;

findAvailablePort(desiredPort).then(port => {
    server.listen(port, () => {
        console.log(`Server listening on port http://localhost:${port}`);
    });
});

Additional information

Contribute to the repository on GitHub.

Check out this package on GitHub Packages or npmjs.