Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

kill-port

Kill the process running on given port


Table of Contents

Table of Contents
  • Install
  • Usage
  • API
  • CLI
  • Contribute
  • License
  • Install

    $ npm install --save kill-port
    # OR
    $ yarn add kill-port

    Usage

    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

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

    Then:

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

    You can also kill multiple ports:

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

    Contribute

    Contributions are welcome. Please open up an issue or create PR if you would like to help out.

    License

    Licensed under the MIT License.