[![npm version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![coverage status][coverage-image]][coverage-url]
[![Language grade: JavaScript][lgtm-image]][lgtm-url]

list-open-files

lsof for Node.js, with an asynchronous Promise-based API and JSON-serializable self-explained objects.

API

``ts
import { lsof, Options } from "list-open-files"

lsof( opts?: Options ): Promise< Array< ProcessInfo > >;
`

The optional options object is defined as:

`ts
interface Options
{
pids?: Array< number >;
concurrency?: number;
}
`

If no pids are provided, the current process will be queried.

If concurrency is specified, it will be used to call the underlying lsof command with that concurrency (at most). The default is built-in and environment specific - it depends on the underlying hardware and is optimized, and therefore generally a good choice. To affect the host computer the least, specify 1, although this will have a very small effect.

The return value is eventually an array (even if only one pid is queried) of zero or more ProcessInfo objects each on the form:

`ts
interface ProcessInfo
{
process: Process;
files: Array< File | FileDescriptorIP | UnknownFile >;
texts: Array< InternalFile >;
}
`

Example

$3

`ts
import { lsof } from "list-open-files"

lsof( ).then( result => console.log( result ) );
`

When run on MacOS as node . > output.txt, will write a file called output.txt (note fd 1)

$3

The following application creates a listening port (which will happen to listen on IPv6, which also supports IPv4). It then connects to it, which results on two more sockets, one for the outgoing client socket, one for the incoming socket since the application connects to itself.

`ts
import { lsof } from "list-open-files"
import { createServer, connect, AddressInfo } from 'net'

async function testIP( ): Promise< void >
{
const [ result1 ] = await lsof( ); // Files before server is listening

const server = createServer( );

await new Promise( ( resolve, reject ) =>
{
server.listen( );
server.on( 'listening', resolve );
server.on( 'error', reject );
} );

const { port } = < AddressInfo >server.address( )

const [ result2 ] = await lsof( ); // Files after the server is listening

await new Promise( ( resolve, reject ) =>
{
const client = connect( port, 'localhost' );
client.on( 'connect', resolve );
client.on( 'error', reject );
} );

const [ result3 ] = await lsof( ); // Files after client connection is established

console.log( result1.files.filter( file => file.type === 'IP' ) );
console.log( result2.files.filter( file => file.type === 'IP' ) );
console.log( result3.files.filter( file => file.type === 'IP' ) );
}

testIP( )
.catch( err => console.error( err ) );
`

This will output:

`js
[]
[
{
fd: 22,
type: 'IP',
access: 'u',
lock: ' ',
size: undefined,
iNode: undefined,
linkCount: undefined,
name: '*:50710',
protocol: 'TCP',
version: 6,
from: undefined,
to: { address: '*', port: 50710 }
}
]
[
{
fd: 22,
type: 'IP',
access: 'u',
lock: ' ',
size: undefined,
iNode: undefined,
linkCount: undefined,
name: '*:50710',
protocol: 'TCP',
version: 6,
from: undefined,
to: { address: '*', port: 50710 }
},
{
fd: 26,
type: 'IP',
access: 'u',
lock: ' ',
size: undefined,
iNode: undefined,
linkCount: undefined,
name: '127.0.0.1:50711->127.0.0.1:50710',
protocol: 'TCP',
version: 4,
from: { address: '127.0.0.1', port: 50711 },
to: { address: '127.0.0.1', port: 50710 }
},
{
fd: 28,
type: 'IP',
access: 'u',
lock: ' ',
size: undefined,
iNode: undefined,
linkCount: undefined,
name: '127.0.0.1:50710->127.0.0.1:50711',
protocol: 'TCP',
version: 6,
from: { address: '127.0.0.1', port: 50710 },
to: { address: '127.0.0.1', port: 50711 }
}
]
`

Reference

$3

`ts
interface ProcessInfo
{
process: Process;
files: Array< File | FileDescriptorIP | UnknownFile >;
texts: Array< InternalFile >;
}
`

$3

`ts
interface Process
{
pid: number;
gpid?: number;
ppid?: number;
tid?: number;
user?: string;
name?: string;
cwd?: InternalFile;
}
`

$3

`ts
interface InternalFile
{
fd: string; // Note string - it's not a traditional file descriptor
type: Type;
access: Access | void;
lock: Lock | void;
size: Size | void;
iNode: INode | void;
linkCount: LinkCount | void;
name: string | void;
}
`

$3

`ts
interface File
{
// From base type
fd: number;
type: Type;
access: Access | void;
lock: Lock | void;
size: Size | void;
iNode: INode | void;
linkCount: LinkCount | void;
name: string | void;

// Specific to File
majorMinorDeviceNumber: MajorMinorDeviceNumber | void;
flags: RawFileFlags | void;
offset: Offset | void;
}
`

$3

`ts
interface UnknownFile
{
// From base type
fd: number;
type: Type;
access: Access | void;
lock: Lock | void;
size: Size | void;
iNode: INode | void;
linkCount: LinkCount | void;
name: string | void;

// Specific to UnknownFile
cmd: string | undefined;
fileStructureShareCount: FileStructureShareCount | undefined; // FCT
charCode: CharacterCode | undefined;
majorMinorDeviceNumber: MajorMinorDeviceNumber | undefined;
fileStructureAddress: FileStructureAddress | undefined; // FILE-ADDR
flags: RawFileFlags | undefined; // FILE-FLAG
loginName: LoginName | undefined;
node: Node | undefined; // NODE
offset: Offset | undefined;
protocolName: ProtocolName | undefined;
deviceNumber: DeviceNumber | undefined // DEVICE
streamIdentification: StreamIdentification | undefined;
tcpTpiInformation: TcpTpiInformation | undefined;
solarisZoneName: SolarisZoneName | undefined;
seLinuxSecurityContext: SELinuxSecurityContext | undefined;
1: any | undefined;
2: any | undefined;
3: any | undefined;
4: any | undefined;
5: any | undefined;
6: any | undefined;
7: any | undefined;
8: any | undefined;
9: any | undefined;
}
`

$3

`ts
interface FileDescriptorIP
{
// From base type
fd: number;
type: 'IP';
access: Access | void;
lock: Lock | void;
size: Size | void;
iNode: INode | void;
linkCount: LinkCount | void;
name: string | void;

// Specific to FileDescriptorIP
protocol: 'TCP' | 'UDP';
version: 4 | 6;
from: IP | void;
to: IP | void;
}
`

$3

`ts
export interface IP
{
address: string;
port: number;
}
``

[npm-image]: https://img.shields.io/npm/v/list-open-files.svg
[npm-url]: https://npmjs.org/package/list-open-files
[travis-image]: https://img.shields.io/travis/grantila/list-open-files/master.svg
[travis-url]: https://travis-ci.org/grantila/list-open-files
[coverage-image]: https://coveralls.io/repos/github/grantila/list-open-files/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/grantila/list-open-files?branch=master
[lgtm-image]: https://img.shields.io/lgtm/grade/javascript/g/grantila/list-open-files.svg?logo=lgtm&logoWidth=18
[lgtm-url]: https://lgtm.com/projects/g/grantila/list-open-files/context:javascript