Include all APIs from website

This commit is contained in:
Daniel Imms
2017-08-18 17:25:40 -07:00
parent 2f60c241ee
commit 3ba3638ab7
2 changed files with 284 additions and 194 deletions
+13 -11
View File
@@ -524,9 +524,10 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
}; };
/** /**
* Blur the terminal. Delegates blur handling to the terminal's DOM element. * Blur the terminal, calling the blur function on the terminal's underlying
* textarea.
*/ */
private blur(): void { public blur(): void {
return this.textarea.blur(); return this.textarea.blur();
} }
@@ -1225,9 +1226,9 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
/** /**
* Scroll the display of the terminal * Scroll the display of the terminal
* @param {number} disp The number of lines to scroll down (negatives scroll up). * @param {number} disp The number of lines to scroll down (negative scroll up).
* @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
* to avoid unwanted events being handled by the veiwport when the event was triggered from the * to avoid unwanted events being handled by the viewport when the event was triggered from the
* viewport originally. * viewport originally.
*/ */
public scrollDisp(disp: number, suppressScrollEvent?: boolean): void { public scrollDisp(disp: number, suppressScrollEvent?: boolean): void {
@@ -1347,12 +1348,13 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
} }
/** /**
* Attaches a custom key event handler which is run before keys are processed, giving consumers of * Attaches a custom key event handler which is run before keys are processed,
* xterm.js ultimate control as to what keys should be processed by the terminal and what keys * giving consumers of xterm.js ultimate control as to what keys should be
* should not. * processed by the terminal and what keys should not.
* @param {function} customKeyEventHandler The custom KeyboardEvent handler to attach. This is a * @param customKeyEventHandler The custom KeyboardEvent handler to attach.
* function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent * This is a function that takes a KeyboardEvent, allowing consumers to stop
* the default action. The function returns whether the event should be processed by xterm.js. * propogation and/or prevent the default action. The function returns whether
* the event should be processed by xterm.js.
*/ */
public attachCustomKeyEventHandler(customKeyEventHandler: CustomKeyEventHandler): void { public attachCustomKeyEventHandler(customKeyEventHandler: CustomKeyEventHandler): void {
this.customKeyEventHandler = customKeyEventHandler; this.customKeyEventHandler = customKeyEventHandler;
@@ -2051,7 +2053,7 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
} }
/** /**
* Clears the entire buffer, making the prompt line the new first line. * Clear the entire buffer, making the prompt line the new first line.
*/ */
public clear(): void { public clear(): void {
if (this.buffer.ybase === 0 && this.buffer.y === 0) { if (this.buffer.ybase === 0 && this.buffer.y === 0) {
+271 -183
View File
@@ -1,194 +1,282 @@
/** /**
* @license MIT * @license MIT
*
* This contains the type declarations for the xterm.js library. Note that
* some interfaces differ between this file and the actual implementation in
* src/, that's because this file declares the *public* API which is intended
* to be stable and consumed by external programs.
*/ */
declare module 'xterm' { /**
type LinkMatcherHandler = (event: MouseEvent, uri: string) => boolean | void; * An object containing start up options for the terminal.
*/
interface ITerminalOptions {
/**
* The number of columns in the terminal.
*/
cols?: number;
export class Terminal { /**
cols: number; * Whether the cursor blinks.
rows: number; */
ydisp: number; cursorBlink?: boolean;
element: HTMLElement;
textarea: HTMLTextAreaElement;
/** /**
* Creates a new `Terminal` object. * The style of the cursor.
* */
* @param {object} options An object containing a set of options. cursorStyle?: 'block' | 'underline' | 'bar';
*/
constructor(options?: any);
/** /**
* Registers an event listener. * Whether input should be disabled.
* @param eventName The name of the event. */
* @param callback The callback. disableStdin?: boolean;
*/
on(eventName: string, callback: (data: any) => void): void;
/** /**
* Resizes the terminal. * The number of rows in the terminal.
* */
* @param x The number of columns to resize to. rows?: number;
* @param y The number of rows to resize to.
*/
resize(columns: number, rows: number): void;
/** /**
* Emits an event. * The amount of scrollback in the terminal. Scrollback is the amount of rows
* @param eventName The name of the event. * that are retained when lines are scrolled beyond the initial viewport.
* @param data The data attached to the event. */
*/ scrollback?: number;
emit(eventName: string, data: any): void;
/** /**
* Writes text to the terminal, followed by a break line character (\n). * The size of tab stops in the terminal.
* @param data The text to write to the terminal. */
*/ tabStopWidth?: number;
writeln(data: string): void; }
/**
* Opens the terminal within an element. type Option = BooleanOption | StringOption | StringArrayOption | NumberOption | GeometryOption | HandlerOption;
* @param parent The element to create the terminal within. type BooleanOption =
* @param focus Focus the terminal, after it gets instantiated in the 'cancelEvents' |
* DOM. 'convertEol' |
*/ 'cursorBlink' |
open(parent: HTMLElement, focus: boolean): void; 'debug' |
'disableStdin' |
/** 'popOnBell' |
* Attaches a custom key event handler which is run before keys are 'screenKeys' |
* processed, giving consumers of xterm.js ultimate control as to what 'useFlowControl' |
* keys should be processed by the terminal and what keys should not. 'visualBell';
* @param customKeyEventHandler The custom KeyboardEvent handler to type StringOption =
* attach. This is a function that takes a KeyboardEvent, allowing 'cursorStyle' |
* consumers to stop propogation and/or prevent the default action. The 'termName';
* function returns whether the event should be processed by xterm.js. type StringArrayOption = 'colors';
*/ type NumberOption =
attachCustomKeyEventHandler(customKeyEventHandler: (...any) => boolean); 'cols' |
'rows' |
/** 'tabStopWidth' |
* Retrieves an option's value from the terminal. 'scrollback';
* @param key The option key. type GeometryOption = 'geometry';
*/ type HandlerOption = 'handler';
getOption(key: string): any;
declare module 'xterm' {
/** /**
* Registers a link matcher, allowing custom link patterns to be matched and * The class that represents an xterm.js terminal.
* handled. */
* @param {RegExp} regex The regular expression to search for, specifically export class Terminal {
* this searches the textContent of the rows. You will want to use \s to match element: HTMLElement;
* a space ' ' character for example. textarea: HTMLTextAreaElement;
* @param {LinkMatcherHandler} handler The callback when the link is called.
* @param {LinkMatcherOptions} [options] Options for the link matcher. /**
* @return {number} The ID of the new matcher, this can be used to deregister. * Creates a new `Terminal` object.
*/ *
registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler , options?: any); * @param options An object containing a set of options.
*/
/** constructor(options?: ITerminalOptions);
* Deregisters a link matcher if it has been registered.
* @param matcherId The link matcher's ID (returned after register) /**
*/ * Unfocus the terminal.
deregisterLinkMatcher(matcherId: number): void; */
blur(): void;
/**
* Gets whether the terminal has an active selection. /**
*/ * Focus the terminal.
hasSelection(): boolean; */
focus(): void;
/**
* Gets the terminal's current selection, this is useful for implementing copy /**
* behavior outside of xterm.js. * Registers an event listener.
*/ * @param type The type of the event.
getSelection(): string; * @param listener The listener.
*/
/** on(type: string, listener: (data: any) => void): void;
* Clears the current terminal selection.
*/ /**
clearSelection(): void; * Deregisters an event listener.
* @param type The type of the event.
/** * @param listener The listener.
* Selects all text within the terminal. */
*/ on(type: string, listener: (data: any) => void): void;
selectAll(): void;
/**
/** * Resizes the terminal.
* Focus the terminal. Delegates focus handling to the terminal's DOM element. * @param x The number of columns to resize to.
*/ * @param y The number of rows to resize to.
focus(): void; */
resize(columns: number, rows: number): void;
/**
* Find the next instance of the term, then scroll to and select it. If it /**
* doesn't exist, do nothing. * Writes text to the terminal, followed by a break line character (\n).
* @param term Tne search term. * @param data The text to write to the terminal.
* @return Whether a result was found. */
*/ writeln(data: string): void;
findNext(term: string): boolean;
/**
/** * Opens the terminal within an element.
* Find the previous instance of the term, then scroll to and select it. If it * @param parent The element to create the terminal within.
* doesn't exist, do nothing. */
* @param term Tne search term. open(parent: HTMLElement): void;
* @return Whether a result was found.
*/ /**
findPrevious(term: string): boolean; * Attaches a custom key event handler which is run before keys are
* processed, giving consumers of xterm.js ultimate control as to what keys
/** * should be processed by the terminal and what keys should not.
* Destroys the terminal. * @param customKeyEventHandler The custom KeyboardEvent handler to attach.
*/ * This is a function that takes a KeyboardEvent, allowing consumers to stop
destroy(): void; * propogation and/or prevent the default action. The function returns
* whether the event should be processed by xterm.js.
/** */
* Scroll the display of the terminal attachCustomKeyEventHandler(customKeyEventHandler: (event: KeyboardEvent) => boolean);
* @param disp The number of lines to scroll down (negatives scroll up).
*/ /**
scrollDisp(disp: number): void; * Retrieves an option's value from the terminal.
* @param key The option key.
/** */
* Scroll the display of the terminal by a number of pages. getOption(key: StringOption): string;
* @param {number} pageCount The number of pages to scroll (negative scrolls up). getOption(key: BooleanOption): boolean;
*/ getOption(key: StringArrayOption): number[];
scrollPages(pageCount: number): void; getOption(key: NumberOption): number;
getOption(key: GeometryOption): [number, number];
/** getOption(key: HandlerOption): (data: string) => void;
* Scrolls the display of the terminal to the top. getOption(key: Option): any;
*/
scrollToTop(): void; // /**
// * Registers a link matcher, allowing custom link patterns to be matched and
/** // * handled.
* Scrolls the display of the terminal to the bottom. // * @param {RegExp} regex The regular expression to search for, specifically
*/ // * this searches the textContent of the rows. You will want to use \s to match
scrollToBottom(): void; // * a space ' ' character for example.
// * @param {LinkMatcherHandler} handler The callback when the link is called.
/** // * @param {LinkMatcherOptions} [options] Options for the link matcher.
* Clears the entire buffer, making the prompt line the new first line. // * @return {number} The ID of the new matcher, this can be used to deregister.
*/ // */
clear(): void; // registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler , options?: any);
/** // /**
* Writes text to the terminal. // * Deregisters a link matcher if it has been registered.
* @param data The text to write to the terminal. // * @param matcherId The link matcher's ID (returned after register)
*/ // */
write(data: string): void; // deregisterLinkMatcher(matcherId: number): void;
/** /**
* Sets an option on the terminal. * Gets whether the terminal has an active selection.
* @param key The option key. */
* @param value The option value. hasSelection(): boolean;
*/
setOption(key: string, value: any): void; /**
* Gets the terminal's current selection, this is useful for implementing
/** * copy behavior outside of xterm.js.
* Tells the renderer to refresh terminal content between two rows (inclusive) at the next */
* opportunity. getSelection(): string;
* @param start The row to start from (between 0 and this.rows - 1).
* @param end The row to end at (between start and this.rows - 1). /**
*/ * Clears the current terminal selection.
refresh(start: number, end: number): void; */
clearSelection(): void;
/**
* Loads an addon, attaching it to the Terminal prototype. /**
* @param addon The addon to load. * Selects all text within the terminal.
*/ */
static loadAddon(addon: string): void; 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;
/**
* Destroys the terminal and detaches it from the DOM.
*/
destroy(): void;
/**
* Scroll the display of the terminal
* @param amount The number of lines to scroll down (negative scroll up).
*/
scrollDisp(amount: number): void;
/**
* Scroll the display of the terminal by a number of pages.
* @param pageCount The number of pages to scroll (negative scrolls up).
*/
scrollPages(pageCount: number): void;
/**
* Scrolls the display of the terminal to the top.
*/
scrollToTop(): void;
/**
* Scrolls the display of the terminal to the bottom.
*/
scrollToBottom(): void;
/**
* Clear the entire buffer, making the prompt line the new first line.
*/
clear(): void;
/**
* Writes text to the terminal.
* @param data The text to write to the terminal.
*/
write(data: string): void;
/**
* Sets an option on the terminal.
* @param key The option key.
* @param value The option value.
*/
setOption(key: StringOption, value: string): void;
setOption(key: BooleanOption, value: boolean): void;
setOption(key: StringArrayOption, value: number[]): void;
setOption(key: NumberOption, value: number): void;
setOption(key: GeometryOption, value: [number, number]): void;
setOption(key: HandlerOption, value: (data: string) => void): void;
setOption(key: Option, value: any): void;
/**
* Tells the renderer to refresh terminal content between two rows
* (inclusive) at the next opportunity.
* @param start The row to start from (between 0 and this.rows - 1).
* @param end The row to end at (between start and this.rows - 1).
*/
refresh(start: number, end: number): void;
/**
* Perform a full reset (RIS, aka '\x1bc').
*/
reset(): void
/**
* Loads an addon, attaching it to the Terminal prototype and making it
* available to all newly created Terminals.
* @param addon The addon to load.
*/
static loadAddon(addon: string): void;
}
} }