Types/doc polish

This commit is contained in:
Daniel Imms
2019-05-12 10:59:26 -07:00
parent f90239377b
commit 3475764946
3 changed files with 5 additions and 9 deletions
+1 -4
View File
@@ -9,7 +9,7 @@ import { IBufferLine, ICellData, IAttributeData } from './core/Types';
import { ICircularList, XtermListener } from './common/Types';
import { Buffer } from './Buffer';
import * as Browser from './common/Platform';
import { ITheme, IDisposable, IMarker, IEvent, ITerminalAddon, ISelectionPosition } from 'xterm';
import { ITheme, IDisposable, IMarker, IEvent, ISelectionPosition } from 'xterm';
import { Terminal } from './Terminal';
import { AttributeData } from './core/buffer/BufferLine';
@@ -30,9 +30,6 @@ export class MockTerminal implements ITerminal {
onKey: IEvent<{ key: string; domEvent: KeyboardEvent; }>;
onRender: IEvent<{ start: number; end: number; }>;
onResize: IEvent<{ cols: number; rows: number; }>;
loadAddon(addon: ITerminalAddon): void {
throw new Error('Method not implemented.');
}
markers: IMarker[];
addMarker(cursorYOffset: number): IMarker {
throw new Error('Method not implemented.');
+1 -5
View File
@@ -3,7 +3,7 @@
* @license MIT
*/
import { ITerminalOptions as IPublicTerminalOptions, IEventEmitter, IDisposable, IMarker, Terminal, ISelectionPosition } from 'xterm';
import { ITerminalOptions as IPublicTerminalOptions, IEventEmitter, IDisposable, IMarker, ISelectionPosition } from 'xterm';
import { IColorSet, IRenderer } from './renderer/Types';
import { ICharset, IAttributeData, ICellData, IBufferLine, CharData } from './core/Types';
import { ICircularList } from './common/Types';
@@ -271,10 +271,6 @@ export interface IPublicTerminal extends IDisposable, IEventEmitter {
reset(): void;
}
export interface ITerminalAddon extends IDisposable {
activate(terminal: Terminal): void;
}
export interface IBufferAccessor {
buffer: IBuffer;
}
+3
View File
@@ -884,6 +884,9 @@ declare module 'xterm' {
loadAddon(addon: ITerminalAddon): void;
}
/**
* An addon that can provide additional functionality to the terminal.
*/
export interface ITerminalAddon extends IDisposable {
/**
* (EXPERIMENTAL) This is called when the addon is activated within xterm.js.