sindresorhus / pid-port

Get the ID of the process that uses a certain port

pid-port

Get the ID of the process that uses a certain port

Install

npm install pid-port

Usage

import {portToPid} from 'pid-port';

try {
	console.log(await portToPid(8080));
	//=> 1337

	const pids = await portToPid([8080, 22]);

	console.log(pids.get(8080));
	//=> 1337

	console.log(pids.get(22));
	//=> 12345
} catch (error) {
	console.log(error);
	//=> 'Could not find a process that uses port `8080`'
}

API

portToPid(port)

Get the process ID for a port.

Returns a Promise<number | undefined> (integer) with the process ID.

port

Type: number (integer)

The port to look up.

portToPid(ports)

Get the process IDs for multiple ports.

Returns a Promise<Map<number, number>> (integer) with the port as key and the process ID as value.

ports

Type: number[] (integer)

The ports to look up.

pidToPorts(pid)

Get the ports for a process ID.

Returns a Promise<Set<number>> with the ports.

pid

Type: number

The process ID to look up.

pidToPorts(pids)

Get the ports for multiple process IDs.

Returns a Promise<Map<number, Set<number>>> with the process ID as the key and the ports as value.

pids

Type: number[]

The process IDs to look up.

allPortsWithPid()

Get all ports with their process ID.

Returns a Promise<Map<number, number>> (integer) with the port as key and the process ID as value.

Related

• fkill-cli - Uses this package to let you kill the process that occupies a certain port
• pid-cwd - Find the working directory of a process from its process ID

pid-port's Issues

`host` option

> require("net").createServer().listen("1234", "127.0.0.1")
> require("net").createServer().listen("1234", "127.0.0.2")

$ ss | grep 1234
LISTEN   0        0                127.0.0.2:1234             0.0.0.0:*       users:(("node",pid=1561254,fd=22))
LISTEN   0        0                127.0.0.1:1234             0.0.0.0:*       users:(("node",pid=1561255,fd=21))

A host option is needed to distinguish. Could accept the same signatures as net.Server#listen.

Add `pid-cwd` to related section

I'm the author of pid-cwd, a cross-platform library to find the directory where a process was started.

I think if these packages are cross-referenced, it will enhance the process for people building things like ultra-runner (uses pid-cwd to show Project column)

You can close the issue to reject.

Support getting process ID from dgram socket

Might be able to use lsof.

root@Devon:/tmp#  lsof /var/run/unraid-api.sock
COMMAND   PID USER   FD   TYPE             DEVICE SIZE/OFF    NODE NAME
node    30784 root   22u  unix 0x00000000e4f3a3c2      0t0 3297853 /var/run/unraid-api.sock type=STREAM
node    30784 root   30u  unix 0x000000005f83b84c      0t0 3309302 /var/run/unraid-api.sock type=STREAM

https://stackoverflow.com/a/49165660/2311366

Support getting ports from a process ID

The inverse of what it currently does.

Could be a method pidPort.pidToPorts(pid).

---

When implemented, it can be used here: https://github.com/sindresorhus/fkill-cli/blob/55af579085a273fdb656b041c004bf2b3cc230fa/interactive.js#L155-L172

UDP problem on macOS

Same problem as kevva/pid-from-port#3.