Example for Terminal#exitStatus usage in comments

Signed-off-by: Philippe Ducas <philippe.ducas@ericsson.ca>
eclipse-theia · May 25, 2022 · 9337635 · 9337635
1 parent eacd3cb
commit 9337635
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/plugin/src/theia.d.ts b/packages/plugin/src/theia.d.ts
@@ -2835,6 +2835,16 @@ export module '@theia/plugin' {
 
         /**
          * The exit status of the terminal, this will be undefined while the terminal is active.
+         *
+         * **Example:** Show a notification with the exit code when the terminal exits with a
+         * non-zero exit code.
+         * ```typescript
+         * window.onDidCloseTerminal(t => {
+         *   if (t.exitStatus && t.exitStatus.code) {
+         *     vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
+         *   }
+         * });
+         * ```
          */
         readonly exitStatus: TerminalExitStatus | undefined;