@types/kill-port

Installation

npm install --save @types/kill-port

Summary

This package contains type definitions for kill-port (https://github.com/tiaanduplessis/kill-port).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/kill-port.

index.d.ts

/// <reference types="node" />

import type { SuccessfulExec } from "shell-exec";

export = killPort;

/**
 * Kill the process running on given port.
 *
 * @param port Port where the process is running.
 * @param protocol Protocol for the port.
 *
 * @example
 * import kill = require('kill-port')
 * import * as http from '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)
 * })
 */
declare function killPort(
    port: number,
    /** @default 'tcp' */
    protocol?: "tcp" | "udp",
): Promise<SuccessfulExec>;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:38 GMT
• Dependencies: @types/node, shell-exec

Credits

These definitions were written by BendingBender.