kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md

Kui API Documentation - v11.0.0 / @kui-shell/plugin-bash-like / StdioChannelWebsocketSide

Class: StdioChannelWebsocketSide

@kui-shell/plugin-bash-like.StdioChannelWebsocketSide

stdin/stdout channel

Hierarchy

• EventEmitter

  ↳ StdioChannelWebsocketSide

Implements

• Channel

Table of contents

Constructors

• constructor

Properties

• readyState
• ws
• wss
• defaultMaxListeners

Methods

• addListener
• close
• emit
• eventNames
• getMaxListeners
• init
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeEventListener
• removeListener
• send
• setMaxListeners
• listenerCount

Constructors

constructor

• new StdioChannelWebsocketSide(wss)

Parameters

Name	Type
wss	EventEmitter

Overrides

EventEmitter.constructor

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:46

Properties

readyState

• readyState: ReadyState = ReadyState.CONNECTING

Implementation of

Channel.readyState

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:40

---

ws

• Private ws: Channel

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:42

---

wss

• Private Readonly wss: EventEmitter

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:44

---

defaultMaxListeners

▪ Static defaultMaxListeners: number

Inherited from

EventEmitter.defaultMaxListeners

Defined in

node_modules/@types/node/events.d.ts:18

Methods

addListener

▸ addListener(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.addListener

Defined in

node_modules/@types/node/events.d.ts:20

---

close

▸ close(): void

Forcibly close the channel

Returns

void

Implementation of

Channel.close

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:144

---

emit

▸ emit(event, ...args): boolean

Parameters

Name	Type
event	string | symbol
...args	any[]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/@types/node/events.d.ts:32

---

eventNames

▸ eventNames(): (string | symbol)[]

Returns

(string | symbol)[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/@types/node/events.d.ts:33

---

getMaxListeners

▸ getMaxListeners(): number

Returns

number

Inherited from

EventEmitter.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:29

---

init

▸ init(child, pollInterval?): Promise<void>

Parameters

Name	Type	Default value
child	ChildProcess	undefined
pollInterval	number	30000

Returns

Promise<void>

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:51

---

listenerCount

▸ listenerCount(type): number

Parameters

Name	Type
type	string | symbol

Returns

number

Inherited from

EventEmitter.listenerCount

Defined in

node_modules/@types/node/events.d.ts:34

---

listeners

▸ listeners(event): Function[]

Parameters

Name	Type
event	string | symbol

Returns

Function[]

Inherited from

EventEmitter.listeners

Defined in

node_modules/@types/node/events.d.ts:30

---

off

▸ off(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.off

Defined in

node_modules/@types/node/events.d.ts:26

---

on

▸ on(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Implementation of

Channel.on

Inherited from

EventEmitter.on

Defined in

node_modules/@types/node/events.d.ts:21

---

once

▸ once(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.once

Defined in

node_modules/@types/node/events.d.ts:22

---

prependListener

▸ prependListener(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.prependListener

Defined in

node_modules/@types/node/events.d.ts:23

---

prependOnceListener

▸ prependOnceListener(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.prependOnceListener

Defined in

node_modules/@types/node/events.d.ts:24

---

rawListeners

▸ rawListeners(event): Function[]

Parameters

Name	Type
event	string | symbol

Returns

Function[]

Inherited from

EventEmitter.rawListeners

Defined in

node_modules/@types/node/events.d.ts:31

---

removeAllListeners

▸ removeAllListeners(event?): StdioChannelWebsocketSide

Parameters

Name	Type
event?	string | symbol

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/@types/node/events.d.ts:27

---

removeEventListener

▸ removeEventListener(eventType, handler): void

Parameters

Name	Type
eventType	string
handler	any

Returns

void

Implementation of

Channel.removeEventListener

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:174

---

removeListener

▸ removeListener(event, listener): StdioChannelWebsocketSide

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.removeListener

Defined in

node_modules/@types/node/events.d.ts:25

---

send

▸ send(msg): void

emit 'message' on the other side

Parameters

Name	Type
msg	string

Returns

void

Implementation of

Channel.send

Defined in

plugins/plugin-bash-like/src/pty/stdio-channel.ts:150

---

setMaxListeners

▸ setMaxListeners(n): StdioChannelWebsocketSide

Parameters

Name	Type
n	number

Returns

StdioChannelWebsocketSide

Inherited from

EventEmitter.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:28

---

listenerCount

▸ Static listenerCount(emitter, event): number

deprecated since v4.0.0

Parameters

Name	Type
emitter	EventEmitter
event	string | symbol

Returns

number

Inherited from

EventEmitter.listenerCount

Defined in

node_modules/@types/node/events.d.ts:17