@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

// Type definitions for kill-port 2.0
// Project: https://github.com/tiaanduplessis/kill-port
// Definitions by: BendingBender <https://github.com/BendingBender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <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: Fri, 26 Aug 2022 07:32:27 GMT
• Dependencies: @types/shell-exec, @types/node
• Global values: none

Credits

These definitions were written by BendingBender.