node_modules/xterm-addon-fit/typings/xterm-addon-fit.d.ts

   1 /**
   2  * Copyright (c) 2019 The xterm.js authors. All rights reserved.
   3  * @license MIT
   4  */
   5
   6 import { Terminal, ITerminalAddon } from 'xterm';
   7
   8 declare module 'xterm-addon-fit' {
   9   /**
  10    * An xterm.js addon that enables resizing the terminal to the dimensions of
  11    * its containing element.
  12    */
  13   export class FitAddon implements ITerminalAddon {
  14     /**
  15      * Creates a new fit addon.
  16      */
  17     constructor();
  18
  19     /**
  20      * Activates the addon
  21      * @param terminal The terminal the addon is being loaded in.
  22      */
  23     public activate(terminal: Terminal): void;
  24
  25     /**
  26      * Disposes the addon.
  27      */
  28     public dispose(): void;
  29
  30     /**
  31      * Resizes the terminal to the dimensions of its containing element.
  32      */
  33     public fit(): void;
  34
  35     /**
  36      * Gets the proposed dimensions that will be used for a fit.
  37      */
  38     public proposeDimensions(): ITerminalDimensions;
  39   }
  40
  41   /**
  42    * Reprepresents the dimensions of a terminal.
  43    */
  44   export interface ITerminalDimensions {
  45     /**
  46      * The number of rows in the terminal.
  47      */
  48     rows: number;
  49
  50     /**
  51      * The number of columns in the terminal.
  52      */
  53     cols: number;
  54   }
  55 }