mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-02-27 03:02:50 +00:00
8b8d67c7d3
This commit: - creates v4 commpatible definition type - bumps current version to v5 - adds documentation based on most recent version - amends tests Thanks!
49 lines
2.1 KiB
TypeScript
49 lines
2.1 KiB
TypeScript
// Type definitions for concurrently 5.1
|
|
// Project: https://github.com/kimmobrunfeldt/concurrently#readme
|
|
// Definitions by: Michael B. <https://github.com/Blasz>
|
|
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
declare function concurrently(
|
|
commands: Array<concurrently.CommandObj | string>,
|
|
options?: concurrently.Options,
|
|
): Promise<null>;
|
|
|
|
declare namespace concurrently {
|
|
interface CommandObj {
|
|
command: string;
|
|
name?: string;
|
|
prefixColor?: string;
|
|
}
|
|
interface Options {
|
|
/** the default input target when reading from `inputStream`. Default: `0`. */
|
|
defaultInputTarget?: number;
|
|
/** a Readable stream to read the input from, eg `process.stdin` */
|
|
inputStream?: NodeJS.ReadableStream;
|
|
/** an array of exiting conditions that will cause a process to kill others. Can contain any of success or failure. */
|
|
killOthers?: Array<'success' | 'failure'>;
|
|
/** a Writable stream to write logs to. Default: `process.stdout` */
|
|
outputStream?: NodeJS.WritableStream;
|
|
/**
|
|
* the prefix type to use when logging processes output.
|
|
*/
|
|
prefix?: 'index' | 'pid' | 'time' | 'command' | 'name' | 'none' | string;
|
|
/** how many characters to show when prefixing with `command`. Default: `10` */
|
|
prefixLength?: number;
|
|
/** whether raw mode should be used, meaning strictly process output will be logged, without any prefixes, colouring or extra stuff. */
|
|
raw?: boolean;
|
|
/** the condition to consider the run was successful. */
|
|
successCondition?: 'first' | 'last';
|
|
/** how many attempts to restart a process that dies will be made. Default: `0` */
|
|
restartTries?: number;
|
|
/** how many milliseconds to wait between process restarts. Default: 0 */
|
|
restartDelay?: number;
|
|
/** a date-fns format to use when prefixing with time. Default: `yyyy-MM-dd HH:mm:ss.ZZZ` */
|
|
timestampFormat?: string;
|
|
}
|
|
}
|
|
|
|
export = concurrently;
|