Skip to content

Commit

Permalink
Clarify TerminalShellExecutionEndEvent.exitCode
Browse files Browse the repository at this point in the history
Part of #145234
  • Loading branch information
Tyriar committed Jun 13, 2024
1 parent c0bbf04 commit bf27d9a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/vscode-dts/vscode.proposed.terminalShellIntegration.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,12 @@ declare module 'vscode' {
readonly execution: TerminalShellExecution;

/**
* The exit code reported by the shell. `undefined` means the shell did not report an exit
* code or the shell reported a command started before the command finished.
* The exit code reported by the shell.
*
* Note that `undefined` means the shell either did not report an exit code (ie. the shell
* integration script is misbehaving) or the shell reported a command started before the command
* finished (eg. a sub-shell was opened). Generally this should not happen, depending on the use
* case, it may be best to treat this as a failure.
*
* @example
* const execution = shellIntegration.executeCommand({
Expand Down

0 comments on commit bf27d9a

Please sign in to comment.