You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
2.9 KiB
117 lines
2.9 KiB
<h1 align="center">kill-port</h1>
|
|
<div align="center">
|
|
<strong>Kill the process running on given port</strong>
|
|
</div>
|
|
<br>
|
|
<div align="center">
|
|
<a href="https://npmjs.org/package/kill-port">
|
|
<img src="https://img.shields.io/npm/v/kill-port.svg?style=flat-square" alt="Package version" />
|
|
</a>
|
|
<a href="https://npmjs.org/package/kill-port">
|
|
<img src="https://img.shields.io/npm/dm/kill-port.svg?style=flat-square" alt="Downloads" />
|
|
</a>
|
|
<a href="https://github.com/feross/standard">
|
|
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square" alt="Standard" />
|
|
</a>
|
|
<a href="https://travis-ci.org/tiaanduplessis/kill-port">
|
|
<img src="https://img.shields.io/travis/tiaanduplessis/kill-port.svg?style=flat-square" alt="Travis Build" />
|
|
</a>
|
|
<a href="https://badge.fury.io/gh/tiaanduplessis%2Fkill-port">
|
|
<img src="https://badge.fury.io/gh/tiaanduplessis%2Fkill-port.svg?style=flat-square" alt="GitHub version" />
|
|
</a>
|
|
<a href="https://dependencyci.com/github/tiaanduplessis/kill-port">
|
|
<img src="https://dependencyci.com/github/tiaanduplessis/kill-port/badge?style=flat-square" alt="Dependency CI" />
|
|
</a>
|
|
<a href="https://github.com/tiaanduplessis/kill-port/blob/master/LICENSE">
|
|
<img src="https://img.shields.io/npm/l/kill-port.svg?style=flat-square" alt="License" />
|
|
</a>
|
|
<a href="http://makeapullrequest.com">
|
|
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs" />
|
|
</a>
|
|
</div>
|
|
<br>
|
|
|
|
<h2>Table of Contents</h2>
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<li><a href="#install">Install</a></li>
|
|
<li><a href="#usage">Usage</a></li>
|
|
<li><a href="#api">API</a></li>
|
|
<li><a href="#cli">CLI</a></li>
|
|
<li><a href="#contribute">Contribute</a></li>
|
|
<li><a href="#license">License</a></li>
|
|
</details>
|
|
|
|
## Install
|
|
|
|
```sh
|
|
$ npm install --save kill-port
|
|
# OR
|
|
$ yarn add kill-port
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
|
|
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
|
|
|
|
```sh
|
|
$ npm install --global kill-port
|
|
# OR
|
|
$ yarn global add kill-port
|
|
```
|
|
|
|
Then:
|
|
|
|
```sh
|
|
$ kill-port --port 8080
|
|
# OR
|
|
$ kill-port 9000
|
|
# OR you can use UDP
|
|
$ kill-port 9000 --method udp
|
|
```
|
|
|
|
You can also kill multiple ports:
|
|
|
|
```sh
|
|
$ 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.
|
|
|