Table of Contents

• Table of Contents
• Install
• Usage
• API
• CLI
• Performance
• Contributing
• License

Install

With npm:

npm install --save kill-port-fast

With yarn:

yarn add kill-port-fast

With pnpm:

pnpm add kill-port-fast

Usage

const kill = require('kill-port-fast')
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-fast as a global package.

Install the package globally:

$ npm install --global kill-port-fast
# OR
$ yarn global add kill-port-fast

Then:

$ kill-port-fast --port 8080
# OR
$ kill-port-fast 9000
# OR you can use UDP
$ kill-port-fast 9000 --method udp

You can also kill multiple ports:

$ kill-port-fast --port 8080,5000,3000
# OR
$ kill-port-fast 9000 3000 5000

You can also use npx to kill-port-fast without installing:

# Kill a single port
$ npx kill-port-fast --port 8080
$ npx kill-port-fast 8080
# Use UDP
$ npx kill-port-fast 9000 --method udp
# Kill multiple ports
$ npx kill-port-fast --port 8080,5000,3000
$ npx kill-port-fast 9000 3000 5000

Performance

Benchmarks show kill-port-fast is 3.5x to 20x faster than kill-port:

| Platform | Single Port | Batch (5 ports) | |----------|--------------|-----------------| | macOS | 20.2x faster | 19.4x faster | | Ubuntu | 5.6x faster | 6.9x faster | | Windows | 3.5x faster | 7.6x faster |

Numbers come from the Benchmark workflow on GitHub-hosted runners; absolute timings vary by machine and by how busy it is.

Fun fact: This package took massively more time to develop than you'll ever save by using it instead of kill-port. But hey, at least you'll save precious milliseconds while I silently regret my life choices.

License

MIT © Gabriel Francisco, based on kill-port © Tiaan du Plessis