Merge branch 'master' into 1128_addons

typings/xterm.d.ts

@@ -314,28 +314,32 @@ declare module 'xterm' {
     /**
      * The element containing the terminal.
      */
-    element: HTMLElement;
+    readonly element: HTMLElement;
 
     /**
      * The textarea that accepts input for the terminal.
      */
-    textarea: HTMLTextAreaElement;
+    readonly textarea: HTMLTextAreaElement;
 
     /**
-     * The number of rows in the terminal's viewport.
+     * The number of rows in the terminal's viewport. Use
+     * `ITerminalOptions.rows` to set this in the constructor and
+     * `Terminal.resize` for when the terminal exists.
      */
-    rows: number;
+    readonly rows: number;
 
     /**
-     * The number of columns in the terminal's viewport.
+     * The number of columns in the terminal's viewport. Use
+     * `ITerminalOptions.cols` to set this in the constructor and
+     * `Terminal.resize` for when the terminal exists.
      */
-    cols: number;
+    readonly cols: number;
 
     /**
      * (EXPERIMENTAL) Get all markers registered against the buffer. If the alt
      * buffer is active this will always return [].
      */
-    markers: IMarker[];
+    readonly markers: IMarker[];
 
     /**
      * Natural language strings that can be localized.
@@ -439,7 +443,9 @@ declare module 'xterm' {
     addDisposableListener(type: string, handler: (...args: any[]) => void): IDisposable;
 
     /**
-     * Resizes the terminal.
+     * Resizes the terminal. It's best practice to debounce calls to resize,
+     * this will help ensure that the pty can respond to the resize event
+     * before another one occurs.
      * @param x The number of columns to resize to.
      * @param y The number of rows to resize to.
      */
@@ -465,7 +471,7 @@ declare module 'xterm' {
      * should be processed by the terminal and what keys should not.
      * @param customKeyEventHandler The custom KeyboardEvent handler to attach.
      * This is a function that takes a KeyboardEvent, allowing consumers to stop
-     * propogation and/or prevent the default action. The function returns
+     * propagation and/or prevent the default action. The function returns
      * whether the event should be processed by xterm.js.
      */
     attachCustomKeyEventHandler(customKeyEventHandler: (event: KeyboardEvent) => boolean): void;