https://github.com/eldoy/fport
Find, wait, check and kill network ports on your system
https://github.com/eldoy/fport
Last synced: about 1 month ago
JSON representation
Find, wait, check and kill network ports on your system
- Host: GitHub
- URL: https://github.com/eldoy/fport
- Owner: eldoy
- License: mit
- Created: 2021-02-19T15:04:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T11:51:41.000Z (about 3 years ago)
- Last Synced: 2025-02-17T01:31:52.106Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 348 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fport
Find, wait, check and kill network ports on your system with NodeJS.
### Usage
You can use fport programmatically or from the command line.
#### Programmatically
Install with:
```
npm i fport
```
Then use it in your app like this:
```js
const fport = require('fport')
// Get an open network port
const port = await fport.port()
// Check if port is taken, default host is localhost
const taken = await fport.taken({ port: 5000 })
// With host
const taken = await fport.taken({ port: 5000, host: '127.0.0.1' })
// Wait for server to start
await fport.wait({
port: 5000, // Default port
host: '127.0.0.1', // Default host
timeout: 100, // The timeout period for each try
tries: 0, // Maximum number of tries
callback: function({ count }) {
console.log(`Tried connecting ${count} times`)
}
})
// Kill an open TCP port
await fport.kill({ port: 5000 })
// Kill a UDP port
await fport.kill({ port: 5000, method: 'udp' })
```
#### From the command line
Install globally with:
```
npm i -g fport
```
Only `kill` is currently supported:
```
# Kill a port syntax
fport kill
# Kill port 5000 on tcp
fport kill 5000
# Kill port 5000 on udp
fport kill 5000 udp
```
MIT Licensed. Enjoy!