Liking cljdoc? Tell your friends :D

dots.vscode.terminal

An individual terminal instance within the integrated terminal.

An individual terminal instance within the integrated terminal.
raw docstring

creation-optionscljs

(creation-options terminal)

The object used to initialize the terminal, this is useful for example to detecting the shell type of when the terminal was not launched by this extension or for detecting what folder the shell was launched in.

Returns: Readonly<TerminalOptions | ExtensionTerminalOptions>

The object used to initialize the terminal, this is useful for example to detecting the
shell type of when the terminal was not launched by this extension or for detecting what
folder the shell was launched in.

**Returns:** `Readonly<TerminalOptions | ExtensionTerminalOptions>`
sourceraw docstring

disposecljs

(dispose terminal)

Dispose and free associated resources.

Returns: void

Dispose and free associated resources.

**Returns:** `void`
sourceraw docstring

exit-statuscljs

(exit-status terminal)

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.

window.onDidCloseTerminal(t => {
  if (t.exitStatus && t.exitStatus.code) {
  	vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
  }
});

Returns: TerminalExitStatus | undefined

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}`);
  }
});
```

**Returns:** `TerminalExitStatus | undefined`
sourceraw docstring

hidecljs

(hide terminal)

Hide the terminal panel if this terminal is currently showing.

Returns: void

Hide the terminal panel if this terminal is currently showing.

**Returns:** `void`
sourceraw docstring

namecljs

(name terminal)

The name of the terminal.

Returns: string

The name of the terminal.

**Returns:** `string`
sourceraw docstring

process-idcljs

(process-id terminal)

The process ID of the shell process.

Returns: Thenable<number | undefined>

The process ID of the shell process.

**Returns:** `Thenable<number | undefined>`
sourceraw docstring

send-textcljs

(send-text terminal text)
(send-text terminal text should-execute?)

Send text to the terminal. The text is written to the stdin of the underlying pty process (shell) of the terminal.

Parameters:

  • text: string - The text to send.
  • should-execute?: boolean | undefined - Indicates that the text being sent should be executed rather than just inserted in the terminal. The character(s) added are \n or \r\n, depending on the platform. This defaults to true.

Returns: void

Send text to the terminal. The text is written to the stdin of the underlying pty process
(shell) of the terminal.

**Parameters:**
- `text`: `string` - The text to send.
- `should-execute?`: `boolean | undefined` - Indicates that the text being sent should be executed rather than just inserted in the terminal.
The character(s) added are `\n` or `\r\n`, depending on the platform. This defaults to `true`.

**Returns:** `void`
sourceraw docstring

showcljs

(show terminal)
(show terminal preserve-focus?)

Show the terminal panel and reveal this terminal in the UI.

Parameters:

  • preserve-focus?: boolean | undefined - When true the terminal will not take focus.

Returns: void

Show the terminal panel and reveal this terminal in the UI.

**Parameters:**
- `preserve-focus?`: `boolean | undefined` - When `true` the terminal will not take focus.

**Returns:** `void`
sourceraw docstring

statecljs

(state terminal)

The current state of the {@link Terminal }.

Returns: TerminalState

The current state of the {@link Terminal }.

**Returns:** `TerminalState`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close