aboutsummaryrefslogtreecommitdiffstats
path: root/vanilla/node_modules/tinyexec/dist/main.d.ts
blob: acf34b9c0eefe7487386a5ace3764987dfb2be84 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/// <reference types="node" resolution-mode="require"/>
import { ChildProcess, SpawnOptions } from "node:child_process";
import { Readable } from "node:stream";

//#region src/non-zero-exit-error.d.ts
declare class NonZeroExitError extends Error {
  readonly result: Result;
  readonly output?: Output;
  get exitCode(): number | undefined;
  constructor(result: Result, output?: Output);
}

//#endregion
//#region src/main.d.ts
interface Output {
  stderr: string;
  stdout: string;
  exitCode: number | undefined;
}
interface PipeOptions extends Options {}
type KillSignal = Parameters<ChildProcess['kill']>[0];
interface OutputApi extends AsyncIterable<string> {
  pipe(command: string, args?: string[], options?: Partial<PipeOptions>): Result;
  process: ChildProcess | undefined;
  kill(signal?: KillSignal): boolean;
  get pid(): number | undefined;
  get aborted(): boolean;
  get killed(): boolean;
  get exitCode(): number | undefined;
}
type Result = PromiseLike<Output> & OutputApi;
interface Options {
  signal: AbortSignal;
  nodeOptions: SpawnOptions;
  timeout: number;
  persist: boolean;
  stdin: ExecProcess;
  throwOnError: boolean;
}
interface TinyExec {
  (command: string, args?: string[], options?: Partial<Options>): Result;
}
declare class ExecProcess implements Result {
  protected _process?: ChildProcess;
  protected _aborted: boolean;
  protected _options: Partial<Options>;
  protected _command: string;
  protected _args: string[];
  protected _resolveClose?: () => void;
  protected _processClosed: Promise<void>;
  protected _thrownError?: Error;
  get process(): ChildProcess | undefined;
  get pid(): number | undefined;
  get exitCode(): number | undefined;
  constructor(command: string, args?: string[], options?: Partial<Options>);
  kill(signal?: KillSignal): boolean;
  get aborted(): boolean;
  get killed(): boolean;
  pipe(command: string, args?: string[], options?: Partial<PipeOptions>): Result;
  [Symbol.asyncIterator](): AsyncIterator<string>;
  protected _waitForOutput(): Promise<Output>;
  then<TResult1 = Output, TResult2 = never>(onfulfilled?: ((value: Output) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
  protected _streamOut?: Readable;
  protected _streamErr?: Readable;
  spawn(): void;
  protected _resetState(): void;
  protected _onError: (err: Error) => void;
  protected _onClose: () => void;
}
declare const x: TinyExec;
declare const exec: TinyExec;

//#endregion
export { ExecProcess, KillSignal, NonZeroExitError, Options, Output, OutputApi, PipeOptions, Result, TinyExec, exec, x };