Liking cljdoc? Tell your friends :D

dots.vscode.terminal-options

Value-object describing what options a terminal should use.

Value-object describing what options a terminal should use.
raw docstring

colorcljs

(color terminal-options)

The icon {@link ThemeColor } for the terminal. The terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.

The icon {@link ThemeColor } for the terminal.
The `terminal.ansi*` theme keys are
recommended for the best contrast and consistency across themes.
sourceraw docstring

cwdcljs

(cwd terminal-options)

A path or Uri for the current working directory to be used for the terminal.

A path or Uri for the current working directory to be used for the terminal.
sourceraw docstring

envcljs

(env terminal-options)

Object with environment variables that will be added to the editor process.

Object with environment variables that will be added to the editor process.
sourceraw docstring

hide-from-user?cljs

(hide-from-user? terminal-options)

When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called. The typical usage for this is when you need to run something that may need interactivity but only want to tell the user about it when interaction is needed. Note that the terminals will still be exposed to all extensions as normal. The hidden terminals will not be restored when the workspace is next opened.

When enabled the terminal will run the process as normal but not be surfaced to the user
until `Terminal.show` is called. The typical usage for this is when you need to run
something that may need interactivity but only want to tell the user about it when
interaction is needed. Note that the terminals will still be exposed to all extensions
as normal. The hidden terminals will not be restored when the workspace is next opened.
sourceraw docstring

icon-pathcljs

(icon-path terminal-options)

The icon path or {@link ThemeIcon } for the terminal.

The icon path or {@link ThemeIcon } for the terminal.
sourceraw docstring

locationcljs

(location terminal-options)

The {@link TerminalLocation } or {@link TerminalEditorLocationOptions } or {@link TerminalSplitLocationOptions } for the terminal.

The {@link TerminalLocation } or {@link TerminalEditorLocationOptions } or {@link TerminalSplitLocationOptions } for the terminal.
sourceraw docstring

messagecljs

(message terminal-options)

A message to write to the terminal on first launch, note that this is not sent to the process but, rather written directly to the terminal. This supports escape sequences such a setting text style.

A message to write to the terminal on first launch, note that this is not sent to the
process but, rather written directly to the terminal. This supports escape sequences such
a setting text style.
sourceraw docstring

namecljs

(name terminal-options)

A human-readable string which will be used to represent the terminal in the UI.

A human-readable string which will be used to represent the terminal in the UI.
sourceraw docstring

set-color!cljs

(set-color! terminal-options value)

The icon {@link ThemeColor } for the terminal. The terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.

The icon {@link ThemeColor } for the terminal.
The `terminal.ansi*` theme keys are
recommended for the best contrast and consistency across themes.
sourceraw docstring

set-cwd!cljs

(set-cwd! terminal-options value)

A path or Uri for the current working directory to be used for the terminal.

A path or Uri for the current working directory to be used for the terminal.
sourceraw docstring

set-env!cljs

(set-env! terminal-options value)

Object with environment variables that will be added to the editor process.

Object with environment variables that will be added to the editor process.
sourceraw docstring

set-hide-from-user!cljs

(set-hide-from-user! terminal-options value)

When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called. The typical usage for this is when you need to run something that may need interactivity but only want to tell the user about it when interaction is needed. Note that the terminals will still be exposed to all extensions as normal. The hidden terminals will not be restored when the workspace is next opened.

When enabled the terminal will run the process as normal but not be surfaced to the user
until `Terminal.show` is called. The typical usage for this is when you need to run
something that may need interactivity but only want to tell the user about it when
interaction is needed. Note that the terminals will still be exposed to all extensions
as normal. The hidden terminals will not be restored when the workspace is next opened.
sourceraw docstring

set-icon-path!cljs

(set-icon-path! terminal-options value)

The icon path or {@link ThemeIcon } for the terminal.

The icon path or {@link ThemeIcon } for the terminal.
sourceraw docstring

set-is-transient!cljs

(set-is-transient! terminal-options value)

Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.

Opt-out of the default terminal persistence on restart and reload.
This will only take effect when `terminal.integrated.enablePersistentSessions` is enabled.
sourceraw docstring

set-location!cljs

(set-location! terminal-options value)

The {@link TerminalLocation } or {@link TerminalEditorLocationOptions } or {@link TerminalSplitLocationOptions } for the terminal.

The {@link TerminalLocation } or {@link TerminalEditorLocationOptions } or {@link TerminalSplitLocationOptions } for the terminal.
sourceraw docstring

set-message!cljs

(set-message! terminal-options value)

A message to write to the terminal on first launch, note that this is not sent to the process but, rather written directly to the terminal. This supports escape sequences such a setting text style.

A message to write to the terminal on first launch, note that this is not sent to the
process but, rather written directly to the terminal. This supports escape sequences such
a setting text style.
sourceraw docstring

set-name!cljs

(set-name! terminal-options value)

A human-readable string which will be used to represent the terminal in the UI.

A human-readable string which will be used to represent the terminal in the UI.
sourceraw docstring

set-shell-args!cljs

(set-shell-args! terminal-options value)

Args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.

Args for the custom shell executable. A string can be used on Windows only which allows
specifying shell args in [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
sourceraw docstring

set-shell-path!cljs

(set-shell-path! terminal-options value)

A path to a custom shell executable to be used in the terminal.

A path to a custom shell executable to be used in the terminal.
sourceraw docstring

set-strict-env!cljs

(set-strict-env! terminal-options value)

Whether the terminal process environment should be exactly as provided in TerminalOptions.env. When this is false (default), the environment will be based on the window's environment and also apply configured platform settings like terminal.integrated.env.windows on top. When this is true, the complete environment must be provided as nothing will be inherited from the process or any configuration.

Whether the terminal process environment should be exactly as provided in
`TerminalOptions.env`. When this is false (default), the environment will be based on the
window's environment and also apply configured platform settings like
`terminal.integrated.env.windows` on top. When this is true, the complete environment
must be provided as nothing will be inherited from the process or any configuration.
sourceraw docstring

shell-argscljs

(shell-args terminal-options)

Args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.

Args for the custom shell executable. A string can be used on Windows only which allows
specifying shell args in [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
sourceraw docstring

shell-pathcljs

(shell-path terminal-options)

A path to a custom shell executable to be used in the terminal.

A path to a custom shell executable to be used in the terminal.
sourceraw docstring

strict-env?cljs

(strict-env? terminal-options)

Whether the terminal process environment should be exactly as provided in TerminalOptions.env. When this is false (default), the environment will be based on the window's environment and also apply configured platform settings like terminal.integrated.env.windows on top. When this is true, the complete environment must be provided as nothing will be inherited from the process or any configuration.

Whether the terminal process environment should be exactly as provided in
`TerminalOptions.env`. When this is false (default), the environment will be based on the
window's environment and also apply configured platform settings like
`terminal.integrated.env.windows` on top. When this is true, the complete environment
must be provided as nothing will be inherited from the process or any configuration.
sourceraw docstring

transient?cljs

(transient? terminal-options)

Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.

Opt-out of the default terminal persistence on restart and reload.
This will only take effect when `terminal.integrated.enablePersistentSessions` is enabled.
sourceraw docstring

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

× close