kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-22 20:39:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

All the interfaces and types are now exported as well

Browse Source
This commit is contained in:
Borek Bernard
2017-10-27 01:26:54 +02:00
committed by GitHub
parent 5761cfc6f2
commit 3373e24ff8
1 changed files with 51 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
types/execa/index.d.ts vendored
View File

@@ -1,63 +1,65 @@
// Type definitions for execa 0.7
// Type definitions for execa 0.8
// Project: https://github.com/sindresorhus/execa#readme
// Definitions by: Douglas Duteil <https://github.com/douglasduteil>
// BendingBender <https://github.com/BendingBender>
// Borek Bernard <https://github.com/borekb>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
// TypeScript Version: 2.5
/// <reference types="node" />
import { ChildProcess, ExecOptions, SpawnOptions, SpawnSyncOptions } from "child_process";
import { Stream } from 'stream';
type StdIOOption = 'pipe' | 'ipc' | 'ignore' | number | Stream | undefined | null;
interface ExecaOptions {
input: string | Buffer | Stream;
preferLocal: boolean;
stripEof: boolean;
extendEnv: boolean;
argv0: string;
localDir: string;
reject: boolean;
cleanup: boolean;
stdin: StdIOOption;
stdout: StdIOOption;
stderr: StdIOOption;
}
type Options = SpawnOptions & ExecaOptions & ExecOptions;
type SyncOptions = SpawnSyncOptions & ExecaOptions & ExecOptions;
interface ExecaReturns {
cmd: string;
code: number;
failed: boolean;
killed: boolean;
signal: string | null;
stderr: string;
stdout: string;
timedOut: boolean;
}
type ExecaError = Error & ExecaReturns;
interface ExecaChildPromise {
catch<TResult = never>(onrejected?: ((reason: ExecaError) => TResult | PromiseLike<TResult>) | null): Promise<ExecaReturns | TResult>;
}
type ExecaChildProcess = ChildProcess & ExecaChildPromise & Promise<ExecaReturns>;
declare function execa(file: string, options?: Partial<Options>): ExecaChildProcess;
declare function execa(file: string, args?: string[], options?: Partial<Options>): ExecaChildProcess;
declare function execa(file: string, options?: Partial<execa.Options>): execa.ExecaChildProcess;
declare function execa(file: string, args?: string[], options?: Partial<execa.Options>): execa.ExecaChildProcess;
declare namespace execa {
function stdout(file: string, options?: Partial<Options>): Promise<string>;
function stdout(file: string, args?: string[], options?: Partial<Options>): Promise<string>;
function stderr(file: string, options?: Partial<Options>): Promise<string>;
function stderr(file: string, args?: string[], options?: Partial<Options>): Promise<string>;
function shell(command: string, options?: Partial<Options>): ExecaChildProcess;
function sync(file: string, options?: Partial<SyncOptions>): ExecaReturns;
function sync(file: string, args?: string[], options?: Partial<SyncOptions>): ExecaReturns;
function shellSync(command: string, options?: Partial<Options>): ExecaReturns;
export type StdIOOption = 'pipe' | 'ipc' | 'ignore' | number | Stream | undefined | null;
export interface ExecaOptions {
input: string | Buffer | Stream;
preferLocal: boolean;
stripEof: boolean;
extendEnv: boolean;
argv0: string;
localDir: string;
reject: boolean;
cleanup: boolean;
stdin: StdIOOption;
stdout: StdIOOption;
stderr: StdIOOption;
}
export type Options = SpawnOptions & ExecaOptions & ExecOptions;
export type SyncOptions = SpawnSyncOptions & ExecaOptions & ExecOptions;
export interface ExecaReturns {
cmd: string;
code: number;
failed: boolean;
killed: boolean;
signal: string | null;
stderr: string;
stdout: string;
timedOut: boolean;
}
export type ExecaError = Error & ExecaReturns;
export interface ExecaChildPromise {
catch<TResult = never>(onrejected?: ((reason: ExecaError) => TResult | PromiseLike<TResult>) | null): Promise<ExecaReturns | TResult>;
}
export type ExecaChildProcess = ChildProcess & ExecaChildPromise & Promise<ExecaReturns>;
export function stdout(file: string, options?: Partial<Options>): Promise<string>;
export function stdout(file: string, args?: string[], options?: Partial<Options>): Promise<string>;
export function stderr(file: string, options?: Partial<Options>): Promise<string>;
export function stderr(file: string, args?: string[], options?: Partial<Options>): Promise<string>;
export function shell(command: string, options?: Partial<Options>): ExecaChildProcess;
export function sync(file: string, options?: Partial<SyncOptions>): ExecaReturns;
export function sync(file: string, args?: string[], options?: Partial<SyncOptions>): ExecaReturns;
export function shellSync(command: string, options?: Partial<Options>): ExecaReturns;
}
export = execa;