Add param and return type to sendText

microsoft · Aug 18, 2016 · d3dd3c6 · d3dd3c6
1 parent 2c95aed
commit d3dd3c6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/vs/vscode.d.ts b/src/vs/vscode.d.ts
@@ -2979,10 +2979,12 @@ declare namespace vscode {
 		/**
 		 * Send text to the terminal.
 		 *
+		 * @param text The text to send to the terminal.
 		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
-		 * required to run a command in the terminal. This defaults to `true`.
+		 * required to run a command in the terminal. The character(s) added are \n or \r\n
+		 * depending on the platform. This defaults to `true`.
 		 */
-		sendText(text: string, addNewLine?: boolean);
+		sendText(text: string, addNewLine?: boolean): void;
 
 		/**
 		 * Reveal this channel in the UI.

diff --git a/src/vs/workbench/api/node/extHostTerminalService.ts b/src/vs/workbench/api/node/extHostTerminalService.ts
@@ -20,7 +20,7 @@ export class ExtHostTerminal implements vscode.Terminal {
 		this._proxy = proxy;
 	}
 
-	public sendText(text: string, addNewLine: boolean = true) {
+	public sendText(text: string, addNewLine: boolean = true): void {
 		this._proxy.$sendText(this._id, text, addNewLine);
 	}