Add warning to IBufferLine.length

xtermjs · Nov 5, 2021 · 32cb95c · 32cb95c
1 parent 50c5579
commit 32cb95c
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
@@ -1343,7 +1343,9 @@ declare module 'xterm' {
 
     /**
      * The length of the line, all call to getCell beyond the length will result
-     * in `undefined`.
+     * in `undefined`. Note that this may exceed columns as the line array may
+     * not be trimmed after a resize, compare against {@link Terminal.cols} to
+     * get the actual maximum length of a line.
      */
     readonly length: number;