Skip to content

Commit 2c836ed

Browse files
committed
Tweak API position/docs
1 parent 26d29ab commit 2c836ed

2 files changed

Lines changed: 14 additions & 14 deletions

File tree

typings/xterm-headless.d.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,13 @@ declare module '@xterm/headless' {
186186
*/
187187
scrollback?: number;
188188

189+
/**
190+
* If enabled ED2 (clear screen) escape sequence will push
191+
* erased text to scrollback.
192+
* This emulates PuTTY default clear screen behavior.
193+
*/
194+
scrollOnDisplayErase?: boolean;
195+
189196
/**
190197
* The scrolling speed multiplier used for adjusting normal scrolling speed.
191198
*/
@@ -255,13 +262,6 @@ declare module '@xterm/headless' {
255262
* All features are disabled by default for security reasons.
256263
*/
257264
windowOptions?: IWindowOptions;
258-
259-
/**
260-
* If enabled ED2 (clear screen) escape sequence will push
261-
* erased text to scrollback.
262-
* This emulates PuTTY default clear screen behavior.
263-
*/
264-
scrollOnDisplayErase?: boolean;
265265
}
266266

267267
/**

typings/xterm.d.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,13 @@ declare module '@xterm/xterm' {
257257
*/
258258
scrollback?: number;
259259

260+
/**
261+
* If enabled the Erase in Display All (ED2) escape sequence will push
262+
* erased text to scrollback, instead of clearing only the viewport portion.
263+
* This emulates PuTTY's default clear screen behavior.
264+
*/
265+
scrollOnDisplayErase?: boolean;
266+
260267
/**
261268
* Whether to scroll to the bottom whenever there is some user input. The
262269
* default is true.
@@ -338,13 +345,6 @@ declare module '@xterm/xterm' {
338345
* decorations underneath the scroll bar.
339346
*/
340347
overviewRuler?: IOverviewRulerOptions;
341-
342-
/**
343-
* If enabled ED2 (clear screen) escape sequence will push
344-
* erased text to scrollback.
345-
* This emulates PuTTY default clear screen behavior.
346-
*/
347-
scrollOnDisplayErase?: boolean;
348348
}
349349

350350
/**

0 commit comments

Comments
 (0)