Add warnings to getCell and getLine

This commit is contained in:
Daniel Imms
2019-05-11 20:49:48 -07:00
parent f41e00ed97
commit 49574be510
+9 -3
View File
@@ -356,9 +356,9 @@ declare module 'xterm' {
readonly cols: number; readonly cols: number;
/** /**
* (EXPERIMENTAL) The terminal's current buffer, note that this might be * (EXPERIMENTAL) The terminal's current buffer, this might be either the
* either the normal buffer or the alt buffer depending on what's running in * normal buffer or the alt buffer depending on what's running in the
* the terminal. * terminal.
*/ */
readonly buffer: IBuffer; readonly buffer: IBuffer;
@@ -897,6 +897,9 @@ declare module 'xterm' {
/** /**
* Gets a line from the buffer, or undefined if the line index does not exist. * Gets a line from the buffer, or undefined if the line index does not exist.
* *
* Note that the result of this function should be used immediately after calling as when the
* terminal updates it could lead to unexpected behavior.
*
* @param y The line index to get. * @param y The line index to get.
*/ */
getLine(y: number): IBufferLine | undefined; getLine(y: number): IBufferLine | undefined;
@@ -911,6 +914,9 @@ declare module 'xterm' {
/** /**
* Gets a cell from the line, or undefined if the line index does not exist. * Gets a cell from the line, or undefined if the line index does not exist.
* *
* Note that the result of this function should be used immediately after calling as when the
* terminal updates it could lead to unexpected behavior.
*
* @param x The character index to get. * @param x The character index to get.
*/ */
getCell(x: number): IBufferCell; getCell(x: number): IBufferCell;