Class DriverCore

Core base part of Driver implementation. Takes care of node-pty and emit "data", "exit" and "start" events

Hierarchy

EventEmitter
- DriverCore
  - DriverCoreIO

Implements

DriverEmitter

Index

Properties

Properties

currentSize

currentSize: object

Type declaration

columns: number
rows: number

destroyed

destroyed: boolean

options

options: DriverOptions

Configuration options of the current instance. Driver is configured on start but options can be changed later while is running.

sleep

sleep: function

Type declaration

- (ms: number): Promise<this>
- Parameters
  - ms: number
  Returns Promise<this>

started

started: boolean

time

time: function

Type declaration

- (ms: number): Promise<this>
- Parameters
  - ms: number
  Returns Promise<this>

Static ERROR_TYPE

ERROR_TYPE: "cli-driver-error"

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

cleanData

cleanData(): this

- Defined in lib/src/driverCore.d.ts:63
Cleans the data buffer. Useful for making sure that the next data chunk is independent from current state.

Returns this

destroy

destroy(): Promise<this>

- Defined in lib/src/driverCore.d.ts:43
destroy current terminal

Returns Promise<this>

emit

emit(event: string | symbol, ...args: any[]): boolean

Implementation of DriverEmitter.emit

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): EventNames[]

Implementation of DriverEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in lib/src/driverCore.d.ts:22
Returns EventNames[]

getCurrentSize

getCurrentSize(): object

- Defined in lib/src/driverCore.d.ts:48
Returns object
- columns: number
- rows: number

getMaxListeners

getMaxListeners(): number

Implementation of DriverEmitter.getMaxListeners

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Implementation of DriverEmitter.listenerCount

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Implementation of DriverEmitter.listeners

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Implementation of DriverEmitter.rawListeners

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of DriverEmitter.removeAllListeners

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resize

resize(columns: number, rows: number): Promise<this>

- Defined in lib/src/driverCore.d.ts:57
Resizes the dimensions of the pty.

Parameters
- columns: number
  
  THe number of columns to use.
- rows: number
  
  The number of rows to use.
Returns Promise<this>

setMaxListeners

setMaxListeners(n: number): this

Implementation of DriverEmitter.setMaxListeners

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

start

start(options?: DriverOptions): Promise<this>

- Defined in lib/src/driverCore.d.ts:33
Starts the client with given options. Will spawn a new terminal

Parameters
- Optional options: DriverOptions
Returns Promise<this>

waitTime

waitTime(ms: number): Promise<this>

- Defined in lib/src/driverCore.d.ts:71
Return a promise resolved after given number of milliseconds

Parameters
- ms: number
  
  will resolve the promise only when given number of milliseconds passed
Returns Promise<this>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Implementation of DriverEmitter.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static systemIsWindows

systemIsWindows(): boolean

- Defined in lib/src/driverCore.d.ts:37
Returns boolean

Generated using TypeDoc