2.0.1 • Published 3 years ago
kill-port v2.0.1
Table of Contents
Install
With npm:
npm install --save kill-portWith yarn:
yarn add kill-portWith pnpm:
pnpm add kill-portUsage
const kill = require('kill-port')
const http = require('http')
const port = 8080
const server = http.createServer((req, res) => {
res.writeHead(200, {
'Content-Type': 'text/plain'
})
res.end('Hi!')
})
server.listen(port, () => {
setTimeout(() => {
// Currently you can kill ports running on TCP or UDP protocols
kill(port, 'tcp')
.then(console.log)
.catch(console.log)
}, 1000)
})API
The module exports a single function that takes a port number as argument. It returns a promise.
CLI
You can use kill-port as a global package.
Install the package globally:
$ npm install --global kill-port
# OR
$ yarn global add kill-portThen:
$ kill-port --port 8080
# OR
$ kill-port 9000
# OR you can use UDP
$ kill-port 9000 --method udpYou can also kill multiple ports:
$ kill-port --port 8080,5000,3000
# OR
$ kill-port 9000 3000 5000You can also use npx to kill-port without installing:
# Kill a single port
$ npx kill-port --port 8080
$ npx kill-port 8080
# Use UDP
$ npx kill-port 9000 --method udp
# Kill multiple ports
$ npx kill-port --port 8080,5000,3000
$ npx kill-port 9000 3000 5000Contributing
Got an idea for a new feature? Found a bug? Contributions are welcome! Please open up an issue or make a pull request.