Merge VS Code 1.23.1 (#1520)

src/typings/node-pty.d.ts

@@ -1,27 +1,81 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the Source EULA. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
+/**
+ * Copyright (c) 2017, Daniel Imms (MIT License).
+ */
 
 declare module 'node-pty' {
-	export function fork(file: string, args: string[], options: any): Terminal;
-	export function spawn(file: string, args: string[], options: any): Terminal;
-	export function createTerminal(file: string, args: string[], options: any): Terminal;
+	/**
+	 * 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++ Comamnd-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 Terminal {
-		pid: number;
-
-		/**
-		 * The title of the active process.
- 		 */
-		process: string;
-
-		on(event: string, callback: (data: any) => void): void;
-
-		resize(columns: number, rows: number): void;
-
-		write(data: string): void;
-
-		kill(): void;
+	export interface IPtyForkOptions {
+	  name?: string;
+	  cols?: number;
+	  rows?: number;
+	  cwd?: string;
+	  env?: { [key: string]: string };
+	  uid?: number;
+	  gid?: number;
+	  encoding?: string;
 	}
-}
+
+	/**
+	 * 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;
+	}
+  }