Clarify you shouldn't use the object after Terminal.dispose

Fixes #3939
2026-08-05 13:43:48 -07:00 · 2022-07-28 10:46:12 -07:00
parent 04b513cf9b
commit 8df878b8a9
2 changed files with 6 additions and 4 deletions
@@ -637,9 +637,10 @@ declare module 'xterm-headless' {
    registerMarker(cursorYOffset?: number): IMarker | undefined;

    /*
-      * Disposes of the terminal, detaching it from the DOM and removing any
-      * active listeners.
-      */
+     * Disposes of the terminal, detaching it from the DOM and removing any
+     * active listeners. Once the terminal is disposed it should not be used
+     * again.
+     */
    dispose(): void;

    /**
@@ -952,7 +952,8 @@ declare module 'xterm' {

    /*
     * Disposes of the terminal, detaching it from the DOM and removing any
-     * active listeners.
+     * active listeners. Once the terminal is disposed it should not be used
+     * again.
     */
    dispose(): void;