From 8df878b8a9c9d9ffa4627fb5397e1c91f35f377d Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Thu, 28 Jul 2022 10:45:43 -0700 Subject: [PATCH] Clarify you shouldn't use the object after Terminal.dispose Fixes #3939 --- typings/xterm-headless.d.ts | 7 ++++--- typings/xterm.d.ts | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/typings/xterm-headless.d.ts b/typings/xterm-headless.d.ts index 666d45c3cd..d39a709862 100644 --- 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 index 4890b4ddf0..8c4e7735f6 100644 --- 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;