release-port

> Note:
> Forked from kill-port

Changes in this fork

- no dependencies
- add sync function to kill port
- typescript
- viteset

Usage

``js
const http = require('node:http')
const { release, releaseSync } = require('release-port')
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
release(port, 'tcp')
.then(console.log)
.catch(console.log)

// or sync function
const { out, err, error } = releaseSync(port, 'tcp')
}, 1000)
})
`

API

$3

`js
release(port, method)
releaseSync(port, method)
`

releaseSync is release's sync function.

#### Options

##### port

- Required: true
- Type: string | number

process port

##### method

- Required: false
- Type: 'udp' | 'tcp'
- Default: 'tcp'

process type

$3

`js
execa(command)
execaSync(command)
`

#### Options

##### command

- Required: true
- Type: string

command to execute in shell.

CLI

You can use release-port as a global package.

Install the package globally:

`sh
$ npm install --global release-port


OR

`sh
$ release-port --port 8080


OR

`sh
$ release-port --port 8080,5000,3000


OR

You can also use npx to release-port without installing:

`sh


Kill a single port

License

MIT License © 2023-PRESENT dmZhan