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

Fixes xtermjs#3939
Tyriar · Jul 28, 2022 · 8df878b · 8df878b
1 parent 04b513c
commit 8df878b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/typings/xterm-headless.d.ts b/typings/xterm-headless.d.ts
@@ -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;
 
     /**

diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
@@ -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;