mirror of
https://github.com/microsoft/vscode.git
synced 2026-08-20 16:23:02 +01:00
86 lines
2.7 KiB
TypeScript
86 lines
2.7 KiB
TypeScript
/**
|
|
* Copyright (c) 2017, Daniel Imms (MIT License).
|
|
*/
|
|
|
|
declare module 'node-pty' {
|
|
/**
|
|
* Forks a process as a pseudoterminal.
|
|
* @param file The file to launch.
|
|
* @param args The file's arguments as argv (string[]) or in a pre-escaped CommandLine format
|
|
* (string). Note that the CommandLine option is only available on Windows and is expected to be
|
|
* escaped properly.
|
|
* @param options The options of the terminal.
|
|
* @see CommandLineToArgvW https://msdn.microsoft.com/en-us/library/windows/desktop/bb776391(v=vs.85).aspx
|
|
* @see Parsing C++ Command-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
|
|
* @see GetCommandLine https://msdn.microsoft.com/en-us/library/windows/desktop/ms683156.aspx
|
|
*/
|
|
export function spawn(file: string, args: string[] | string, options: IPtyForkOptions): IPty;
|
|
|
|
export interface IPtyForkOptions {
|
|
name?: string;
|
|
cols?: number;
|
|
rows?: number;
|
|
cwd?: string;
|
|
env?: { [key: string]: string };
|
|
uid?: number;
|
|
gid?: number;
|
|
encoding?: string;
|
|
/**
|
|
* Whether to use the experimental ConPTY system on Windows. This setting will be ignored on
|
|
* non-Windows.
|
|
*/
|
|
experimentalUseConpty?: boolean;
|
|
}
|
|
|
|
/**
|
|
* An interface representing a pseudoterminal, on Windows this is emulated via the winpty library.
|
|
*/
|
|
export interface IPty {
|
|
/**
|
|
* The process ID of the outer process.
|
|
*/
|
|
pid: number;
|
|
|
|
/**
|
|
* The title of the active process.
|
|
*/
|
|
process: string;
|
|
|
|
/**
|
|
* Adds a listener to the data event, fired when data is returned from the pty.
|
|
* @param event The name of the event.
|
|
* @param listener The callback function.
|
|
*/
|
|
on(event: 'data', listener: (data: string) => void): void;
|
|
|
|
/**
|
|
* Adds a listener to the exit event, fired when the pty exits.
|
|
* @param event The name of the event.
|
|
* @param listener The callback function, exitCode is the exit code of the process and signal is
|
|
* the signal that triggered the exit. signal is not supported on Windows.
|
|
*/
|
|
on(event: 'exit', listener: (exitCode: number, signal?: number) => void): void;
|
|
|
|
/**
|
|
* Resizes the dimensions of the pty.
|
|
* @param columns The number of columns to use.
|
|
* @param rows The number of rows to use.
|
|
*/
|
|
resize(columns: number, rows: number): void;
|
|
|
|
/**
|
|
* Writes data to the pty.
|
|
* @param data The data to write.
|
|
*/
|
|
write(data: string): void;
|
|
|
|
/**
|
|
* Kills the pty.
|
|
* @param signal The signal to use, defaults to SIGHUP. If the TIOCSIG/TIOCSIGNAL ioctl is not
|
|
* supported then the process will be killed instead. This parameter is not supported on
|
|
* Windows.
|
|
* @throws Will throw when signal is used on Windows.
|
|
*/
|
|
kill(signal?: string): void;
|
|
}
|
|
} |