DefinitelyTyped/types/fkill/index.d.ts
2019-01-18 01:25:28 +01:00

41 lines
1.0 KiB
TypeScript

// Type definitions for fkill 5.3
// Project: https://github.com/sindresorhus/fkill#readme
// Definitions by: BendingBender <https://github.com/BendingBender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
export = fkill;
/**
* Fabulously kill processes. Cross-platform.
*
* @param input One or more process IDs/names/ports to kill.
* To kill a port, prefix it with a colon. For example: `:8080`.
*/
declare function fkill(
input: number | string | Array<string | number>,
options?: fkill.Options
): Promise<void>;
declare namespace fkill {
interface Options {
/**
* Force kill the process.
* @default false
*/
force?: boolean;
/**
* Kill all child processes along with the parent process. *(Windows only)*
* @default true
*/
tree?: boolean;
/**
* Ignore capitalization when killing a process.
* Note that the case is always ignored on Windows.
* @default false
*/
ignoreCase?: boolean;
}
}