Update vscode-xterm.d.ts

src/typings/vscode-xterm.d.ts

@@ -17,6 +17,13 @@ declare module 'vscode-xterm' {
 	 * An object containing start up options for the terminal.
 	 */
 	export interface ITerminalOptions {
+		/**
+		 * Whether background should support non-opaque color. It must be set before
+		 * executing open() method and can't be changed later without excuting it again.
+		 * Warning: Enabling this option can reduce performances somewhat.
+		 */
+		allowTransparency?: boolean;
+
 		/**
 		 * A data uri of the sound to use for the bell (needs bellStyle = 'sound').
 		 */
@@ -49,6 +56,8 @@ declare module 'vscode-xterm' {
 
 		/**
 		 * Whether to enable the rendering of bold text.
+		 *
+		 * @deprecated Use fontWeight and fontWeightBold instead.
 		 */
 		enableBold?: boolean;
 
@@ -181,8 +190,8 @@ declare module 'vscode-xterm' {
 		matchIndex?: number;
 
 		/**
-		 * A callback that validates an individual link, returning true if valid and
-		 * false if invalid.
+		 * A callback that validates whether to create an individual link, pass
+		 * whether the link is valid to the callback.
 		 */
 		validationCallback?: (uri: string, callback: (isValid: boolean) => void) => void;
 
@@ -227,6 +236,12 @@ declare module 'vscode-xterm' {
 		dispose(): void;
 	}
 
+	export interface IMarker extends IDisposable {
+		readonly id: number;
+		readonly isDisposed: boolean;
+		readonly line: number;
+	}
+
 	export interface ILocalizableStrings {
 		blankLine: string;
 		promptLabel: string;
@@ -236,7 +251,7 @@ declare module 'vscode-xterm' {
 	/**
 	 * The class that represents an xterm.js terminal.
 	 */
-	export class Terminal {
+	export class Terminal implements IEventEmitter {
 		/**
 		 * The element containing the terminal.
 		 */
@@ -257,6 +272,12 @@ declare module 'vscode-xterm' {
 		 */
 		cols: number;
 
+		/**
+		 * (EXPERIMENTAL) Get all markers registered against the buffer. If the alt
+		 * buffer is active this will always return [].
+		 */
+		markers: IMarker[];
+
 		/**
 		 * Natural language strings that can be localized.
 		 */
@@ -290,7 +311,7 @@ declare module 'vscode-xterm' {
 		 * @param type The type of the event.
 		 * @param listener The listener.
 		 */
-		on(type: 'data', listener: (data?: string) => void): void;
+		on(type: 'data', listener: (...args: any[]) => void): void;
 		/**
 		 * Registers an event listener.
 		 * @param type The type of the event.
@@ -341,6 +362,10 @@ declare module 'vscode-xterm' {
 		 */
 		off(type: 'blur' | 'focus' | 'linefeed' | 'selection' | 'data' | 'key' | 'keypress' | 'keydown' | 'refresh' | 'resize' | 'scroll' | 'title' | string, listener: (...args: any[]) => void): void;
 
+		emit(type: string, data?: any): void;
+
+		addDisposableListener(type: string, handler: (...args: any[]) => void): IDisposable;
+
 		/**
 		 * Resizes the terminal.
 		 * @param x The number of columns to resize to.
@@ -383,7 +408,7 @@ declare module 'vscode-xterm' {
 		 * @param options Options for the link matcher.
 		 * @return The ID of the new matcher, this can be used to deregister.
 		 */
-		registerLinkMatcher(regex: RegExp, handler: (event: MouseEvent, uri: string) => boolean | void, options?: ILinkMatcherOptions): number;
+		registerLinkMatcher(regex: RegExp, handler: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions): number;
 
 		/**
 		 * (EXPERIMENTAL) Deregisters a link matcher if it has been registered.
@@ -391,6 +416,13 @@ declare module 'vscode-xterm' {
 		 */
 		deregisterLinkMatcher(matcherId: number): void;
 
+		/**
+		 * (EXPERIMENTAL) Adds a marker to the normal buffer and returns it. If the
+		 * alt buffer is active, undefined is returned.
+		 * @param cursorYOffset The y position offset of the marker from the cursor.
+		 */
+		addMarker(cursorYOffset: number): IMarker;
+
 		/**
 		 * Gets whether the terminal has an active selection.
 		 */
@@ -412,21 +444,12 @@ declare module 'vscode-xterm' {
 		 */
 		selectAll(): void;
 
-		// /**
-		//  * Find the next instance of the term, then scroll to and select it. If it
-		//  * doesn't exist, do nothing.
-		//  * @param term Tne search term.
-		//  * @return Whether a result was found.
-		//  */
-		// findNext(term: string): boolean;
-
-		// /**
-		//  * Find the previous instance of the term, then scroll to and select it. If it
-		//  * doesn't exist, do nothing.
-		//  * @param term Tne search term.
-		//  * @return Whether a result was found.
-		//  */
-		// findPrevious(term: string): boolean;
+		/**
+		 * Selects text in the buffer between 2 lines.
+		 * @param start The 0-based line index to select from (inclusive).
+		 * @param end The 0-based line index to select to (inclusive).
+		 */
+		selectLines(start: number, end: number): void;
 
 		/**
 		 * Destroys the terminal and detaches it from the DOM.
@@ -455,6 +478,12 @@ declare module 'vscode-xterm' {
 		 */
 		scrollToBottom(): void;
 
+		/**
+		 * Scrolls to a line within the buffer.
+		 * @param line The 0-based line index to scroll to.
+		 */
+		scrollToLine(line: number): void;
+
 		/**
 		 * Clear the entire buffer, making the prompt line the new first line.
 		 */
@@ -470,7 +499,7 @@ declare module 'vscode-xterm' {
 		 * Retrieves an option's value from the terminal.
 		 * @param key The option key.
 		 */
-		getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'termName'): string;
+		getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'fontWeight' | 'fontWeightBold' | 'termName'): string;
 		/**
 		 * Retrieves an option's value from the terminal.
 		 * @param key The option key.
@@ -503,6 +532,12 @@ declare module 'vscode-xterm' {
 		 * @param value The option value.
 		 */
 		setOption(key: 'fontFamily' | 'termName' | 'bellSound', value: string): void;
+		/**
+		* Sets an option on the terminal.
+		* @param key The option key.
+		* @param value The option value.
+		*/
+		setOption(key: 'fontWeight' | 'fontWeightBold', value: null | 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900'): void;
 		/**
 		 * Sets an option on the terminal.
 		 * @param key The option key.
@@ -545,6 +580,12 @@ declare module 'vscode-xterm' {
 		 * @param value The option value.
 		 */
 		setOption(key: 'theme', value: ITheme): void;
+		/**
+		 * Sets an option on the terminal.
+		 * @param key The option key.
+		 * @param value The option value.
+		 */
+		setOption(key: 'cols' | 'rows', value: number): void;
 		/**
 		 * Sets an option on the terminal.
 		 * @param key The option key.