Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TerminalWidgetFactoryOptions

Hierarchy

Index

Properties

Properties

Optional Readonly attributes

attributes: {}

Terminal attributes. Can be useful to apply some implementation specific information.

Type declaration

  • [key: string]: string | null

created

created: string

Optional Readonly cwd

cwd: string | default

Current working directory.

Optional Readonly destroyTermOnClose

destroyTermOnClose: boolean

In case destroyTermOnClose is true - terminal process will be destroyed on close terminal widget, otherwise will be kept alive.

Optional Readonly env

env: {}

Environment variables for terminal.

Type declaration

  • [key: string]: string | null

Optional Readonly id

id: string

Terminal id. Should be unique for all DOM.

Optional Readonly isPseudoTerminal

isPseudoTerminal: boolean

Whether it is a pseudo terminal where an extension controls its input and output.

Optional Readonly kind

kind: string

Terminal kind that indicates whether a terminal is created by a user or by some extension for a user

Optional Readonly shellArgs

shellArgs: string[]

Shell arguments to executable shell, for example: [-l] - without login.

Optional Readonly shellPath

shellPath: string

Path to the executable shell. For example: /bin/bash, bash, sh.

Optional Readonly title

title: string

Human readable terminal representation on the UI.

Optional Readonly useServerTitle

useServerTitle: boolean

Terminal server side can send to the client terminal title to display this value on the UI. If useServerTitle = true then display this title, otherwise display title defined by 'title' argument.