aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/concurrently/dist/src/concurrently.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/concurrently/dist/src/concurrently.d.ts')
-rw-r--r--node_modules/concurrently/dist/src/concurrently.d.ts110
1 files changed, 110 insertions, 0 deletions
diff --git a/node_modules/concurrently/dist/src/concurrently.d.ts b/node_modules/concurrently/dist/src/concurrently.d.ts
new file mode 100644
index 0000000..7af8297
--- /dev/null
+++ b/node_modules/concurrently/dist/src/concurrently.d.ts
@@ -0,0 +1,110 @@
+/// <reference types="node" />
+import { Writable } from 'stream';
+import { CloseEvent, Command, CommandInfo, KillProcess, SpawnCommand } from './command';
+import { SuccessCondition } from './completion-listener';
+import { FlowController } from './flow-control/flow-controller';
+import { Logger } from './logger';
+/**
+ * A command that is to be passed into `concurrently()`.
+ * If value is a string, then that's the command's command line.
+ * Fine grained options can be defined by using the object format.
+ */
+export type ConcurrentlyCommandInput = string | ({
+ command: string;
+} & Partial<CommandInfo>);
+export type ConcurrentlyResult = {
+ /**
+ * All commands created and ran by concurrently.
+ */
+ commands: Command[];
+ /**
+ * A promise that resolves when concurrently ran successfully according to the specified
+ * success condition, or reject otherwise.
+ *
+ * Both the resolved and rejected value is the list of all command's close events.
+ */
+ result: Promise<CloseEvent[]>;
+};
+export type ConcurrentlyOptions = {
+ logger?: Logger;
+ /**
+ * Which stream should the commands output be written to.
+ */
+ outputStream?: Writable;
+ /**
+ * Whether the output should be ordered as if the commands were run sequentially.
+ */
+ group?: boolean;
+ /**
+ * A comma-separated list of chalk colors or a string for available styles listed below to use on prefixes.
+ * If there are more commands than colors, the last color will be repeated.
+ *
+ * Available modifiers:
+ * - `reset`, `bold`, `dim`, `italic`, `underline`, `inverse`, `hidden`, `strikethrough`
+ *
+ * Available colors:
+ * - `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `gray`,
+ * any hex values for colors (e.g. `#23de43`) or `auto` for an automatically picked color
+ *
+ * Available background colors:
+ * - `bgBlack`, `bgRed`, `bgGreen`, `bgYellow`, `bgBlue`, `bgMagenta`, `bgCyan`, `bgWhite`
+ *
+ * @see {@link https://www.npmjs.com/package/chalk} for more information.
+ */
+ prefixColors?: string | string[];
+ /**
+ * Maximum number of commands to run at once.
+ * Exact number or a percent of CPUs available (for example "50%").
+ *
+ * If undefined, then all processes will start in parallel.
+ * Setting this value to 1 will achieve sequential running.
+ */
+ maxProcesses?: number | string;
+ /**
+ * Whether commands should be spawned in raw mode.
+ * Defaults to false.
+ */
+ raw?: boolean;
+ /**
+ * The current working directory of commands which didn't specify one.
+ * Defaults to `process.cwd()`.
+ */
+ cwd?: string;
+ /**
+ * @see CompletionListener
+ */
+ successCondition?: SuccessCondition;
+ /**
+ * Which flow controllers should be applied on commands spawned by concurrently.
+ * Defaults to an empty array.
+ */
+ controllers: FlowController[];
+ /**
+ * A function that will spawn commands.
+ * Defaults to the `spawn-command` module.
+ */
+ spawn: SpawnCommand;
+ /**
+ * A function that will kill processes.
+ * Defaults to the `tree-kill` module.
+ */
+ kill: KillProcess;
+ /**
+ * Signal to send to killed processes.
+ */
+ killSignal?: string;
+ /**
+ * List of additional arguments passed that will get replaced in each command.
+ * If not defined, no argument replacing will happen.
+ *
+ * @see ExpandArguments
+ */
+ additionalArguments?: string[];
+};
+/**
+ * Core concurrently functionality -- spawns the given commands concurrently and
+ * returns the commands themselves + the result according to the specified success condition.
+ *
+ * @see CompletionListener
+ */
+export declare function concurrently(baseCommands: ConcurrentlyCommandInput[], baseOptions?: Partial<ConcurrentlyOptions>): ConcurrentlyResult;
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage