Nutty Peanut Marshmallow

    kill-port
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/kill-port package

    2.0.1 • Public • Published
    Logo

    kill-port

    Kill process running on given port


    Table of Contents

    Install

    With npm:

    npm install --save kill-port

    With yarn:

    yarn add kill-port

    With pnpm:

    pnpm 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

    You can use kill-port as a global package.

    Install the package globally:

    $ 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

    You 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 5000

    Contributing

    Got an idea for a new feature? Found a bug? Contributions are welcome! Please open up an issue or make a pull request.

    License

    MIT © Tiaan du Plessis

    Install

    npm i kill-port

    DownloadsWeekly Downloads

    164,690

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    175 kB

    Total Files

    11

    Last publish

    Collaborators

    • tiaanduplessis