Skip to content

@k8slens/extensions

Globals / "src/renderer/api/terminal-api" / TerminalApi

Class: TerminalApi#

Hierarchy#

↳ TerminalApi

Index#

Constructors#

Properties#

Accessors#

Methods#

Object literals#

Constructors#

constructor#

+ new TerminalApi(options: TerminalApiQuery): TerminalApi

Overrides WebSocketApi.constructor

Defined in src/renderer/api/terminal-api.ts:37

Parameters:

Name Type
options TerminalApiQuery

Returns: TerminalApi

Properties#

isReady#

• isReady: boolean = false

Defined in src/renderer/api/terminal-api.ts:37

onClose#

• onClose: EventEmitter\<[]> = new EventEmitter\<[]>()

Inherited from WebSocketApi.onClose

Defined in src/renderer/api/websocket-api.ts:37

onData#

• onData: EventEmitter\<[string]> = new EventEmitter\<[string]>()

Inherited from WebSocketApi.onData

Defined in src/renderer/api/websocket-api.ts:36

onOpen#

• onOpen: EventEmitter\<[]> = new EventEmitter\<[]>()

Inherited from WebSocketApi.onOpen

Defined in src/renderer/api/websocket-api.ts:35

onReady#

• onReady: EventEmitter\<[]> = new EventEmitter\<[]>()

Defined in src/renderer/api/terminal-api.ts:36

options#

• Protected options: TerminalApiQuery

Defined in src/renderer/api/terminal-api.ts:39

params#

• Protected params: IParams

Inherited from WebSocketApi.params

Defined in src/renderer/api/websocket-api.ts:47

pendingCommands#

• Protected pendingCommands: IMessage[] = []

Inherited from WebSocketApi.pendingCommands

Defined in src/renderer/api/websocket-api.ts:28

pingMessage#

• Protected pingMessage: string = "PING"

Inherited from WebSocketApi.pingMessage

Defined in src/renderer/api/websocket-api.ts:31

pingTimer#

• Protected pingTimer: any

Inherited from WebSocketApi.pingTimer

Defined in src/renderer/api/websocket-api.ts:30

readyState#

• readyState: WebSocketApiState = WebSocketApiState.PENDING

Inherited from WebSocketApi.readyState

Defined in src/renderer/api/websocket-api.ts:33

reconnectTimer#

• Protected reconnectTimer: any

Inherited from WebSocketApi.reconnectTimer

Defined in src/renderer/api/websocket-api.ts:29

size#

• Protected size: { Height: number ; Width: number }

Defined in src/renderer/api/terminal-api.ts:34

Type declaration:

Name Type
Height number
Width number

socket#

• Protected socket: WebSocket

Inherited from WebSocketApi.socket

Defined in src/renderer/api/websocket-api.ts:27

Accessors#

isConnected#

• get isConnected(): boolean

Inherited from WebSocketApi.isConnected

Defined in src/renderer/api/websocket-api.ts:58

Returns: boolean

isOnline#

• get isOnline(): boolean

Inherited from WebSocketApi.isOnline

Defined in src/renderer/api/websocket-api.ts:63

Returns: boolean

Methods#

_onClose#

▸ Protected_onClose(evt: CloseEvent): void

Overrides WebSocketApi._onClose

Defined in src/renderer/api/terminal-api.ts:122

Parameters:

Name Type
evt CloseEvent

Returns: void

_onError#

▸ Protected_onError(evt: Event): void

Inherited from WebSocketApi._onError

Defined in src/renderer/api/websocket-api.ts:148

Parameters:

Name Type
evt Event

Returns: void

_onMessage#

▸ Protected_onMessage(evt: MessageEvent): void

Inherited from WebSocketApi._onMessage

Defined in src/renderer/api/websocket-api.ts:142

Parameters:

Name Type
evt MessageEvent

Returns: void

_onOpen#

▸ Protected_onOpen(evt: Event): void

Overrides WebSocketApi._onOpen

Defined in src/renderer/api/terminal-api.ts:115

Parameters:

Name Type
evt Event

Returns: void

_onReady#

▸ Protected_onReady(data: string): boolean

Defined in src/renderer/api/terminal-api.ts:83

Parameters:

Name Type
data string

Returns: boolean

connect#

▸ connect(): Promise\

Overrides WebSocketApi.connect

Defined in src/renderer/api/terminal-api.ts:63

Returns: Promise\

destroy#

▸ destroy(): void

Overrides WebSocketApi.destroy

Defined in src/renderer/api/terminal-api.ts:70

Returns: void

emitError#

▸ ProtectedemitError(error: string): void

Defined in src/renderer/api/terminal-api.ts:139

Parameters:

Name Type
error string

Returns: void

emitStatus#

▸ ProtectedemitStatus(data: string, options?: { color?: TerminalColor ; showTime?: boolean }): void

Defined in src/renderer/api/terminal-api.ts:127

Parameters:

Name Type Default value
data string -
options { color?: TerminalColor ; showTime?: boolean } {}

Returns: void

flush#

▸ Protectedflush(): void

Inherited from WebSocketApi.flush

Defined in src/renderer/api/websocket-api.ts:126

Returns: void

getUrl#

▸ getUrl(): Promise\

Defined in src/renderer/api/terminal-api.ts:47

Returns: Promise\

parseMessage#

▸ ProtectedparseMessage(data: string): any

Overrides WebSocketApi.parseMessage

Defined in src/renderer/api/terminal-api.ts:110

Parameters:

Name Type
data string

Returns: any

ping#

▸ ping(): void

Inherited from WebSocketApi.ping

Defined in src/renderer/api/websocket-api.ts:83

Returns: void

reconnect#

▸ reconnect(): void

Overrides WebSocketApi.reconnect

Defined in src/renderer/api/terminal-api.ts:93

Returns: void

removeAllListeners#

▸ removeAllListeners(): void

Overrides WebSocketApi.removeAllListeners

Defined in src/renderer/api/terminal-api.ts:77

Returns: void

send#

▸ send(command: string): void

Inherited from WebSocketApi.send

Defined in src/renderer/api/websocket-api.ts:113

Parameters:

Name Type
command string

Returns: void

sendCommand#

▸ sendCommand(key: string, channel?: TerminalChannels): void

Defined in src/renderer/api/terminal-api.ts:98

Parameters:

Name Type Default value
key string -
channel TerminalChannels TerminalChannels.STDIN

Returns: void

sendTerminalSize#

▸ sendTerminalSize(cols: number, rows: number): void

Defined in src/renderer/api/terminal-api.ts:102

Parameters:

Name Type
cols number
rows number

Returns: void

setParams#

▸ setParams(params: Partial\<IParams>): void

Inherited from WebSocketApi.setParams

Defined in src/renderer/api/websocket-api.ts:67

Parameters:

Name Type
params Partial\<IParams>

Returns: void

writeLog#

▸ ProtectedwriteLog(...data: any[]): void

Inherited from WebSocketApi.writeLog

Defined in src/renderer/api/websocket-api.ts:164

Parameters:

Name Type
...data any[]

Returns: void

Object literals#

defaultParams#

▪ Static defaultParams: object

Inherited from WebSocketApi.defaultParams

Defined in src/renderer/api/websocket-api.ts:39

Properties:

Name Type Value
autoConnect true true
flushOnOpen true true
logging false false
pingIntervalSeconds number 0
reconnectDelaySeconds number 10
Last update: November 10, 2020