Class WebdaTerminal

Hierarchy

Terminal
- WebdaTerminal

Constructors

Properties

_refresh

format

height

history

inputs

level

logo

logoWidth

reset

rl

scrollY

title

tty

versions

wo

Constructors

new WebdaTerminal(wo: WorkerOutput, versions: any, logo?: string[], level?: WorkerLogLevel, format?: string, tty?: boolean): WebdaTerminal

Overrides Terminal.__constructor

Parameters
- wo: WorkerOutput
- versions: any
- Default value logo: string[] = undefined
- Default value level: WorkerLogLevel = undefined
- Default value format: string = undefined
- Default value tty: boolean = undefined
Returns WebdaTerminal
- Defined in packages/shell/src/console/terminal.ts:5

Properties

_refresh: Timeout

format: string

hasProgress: boolean

height: number

history: string[]

historySize: number

inputValid: boolean

inputValue: string

inputs: WorkerInput[]

level: WorkerLogLevel

logo: string[]

logoWidth: number

progressChar: number

progressChars: string[]

progresses: object

Type declaration

[key: string]: WorkerProgress

reset: boolean

rl: Interface

scrollY: number

title: string

tty: boolean

versions: any

wo: WorkerOutput

Methods

clearScreen(): void

Inherited from WebdaTerminal.clearScreen

Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:63

close(): void

Inherited from WebdaTerminal.close

Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:33

displayBar(ratio: any, barlen: any): string

Inherited from WebdaTerminal.displayBar

Parameters
- ratio: any
- barlen: any
Returns string
- Defined in packages/workout/lib/terminal/terminal.d.ts:42

displayFooter(): string

Inherited from WebdaTerminal.displayFooter

Returns string
- Defined in packages/workout/lib/terminal/terminal.d.ts:46

displayHistory(lines: number, complete?: boolean): string

Inherited from WebdaTerminal.displayHistory

Parameters
- lines: number
- Optional complete: boolean
Returns string
- Defined in packages/workout/lib/terminal/terminal.d.ts:61

displayProgress(p: WorkerProgress): string

Inherited from WebdaTerminal.displayProgress

Parameters
- p: WorkerProgress
Returns string
- Defined in packages/workout/lib/terminal/terminal.d.ts:45

displayScreen(): Promise<void>

Inherited from WebdaTerminal.displayScreen

Returns Promise<void>
- Defined in packages/workout/lib/terminal/terminal.d.ts:62

displayString(str: string, limit?: number): any

Overrides Terminal.displayString

Parameters
- str: string
- Default value limit: number = undefined
Returns any
- Defined in packages/shell/src/console/terminal.ts:76

displayTitle(): string

Inherited from WebdaTerminal.displayTitle

Returns string
- Defined in packages/workout/lib/terminal/terminal.d.ts:44

getBar(size: number, complete: boolean): string

Overrides Terminal.getBar

Parameters
- size: number
- complete: boolean
Returns string
- Defined in packages/shell/src/console/terminal.ts:61

getFooterSize(): number

Inherited from WebdaTerminal.getFooterSize

Returns number
- Defined in packages/workout/lib/terminal/terminal.d.ts:38

getLogo(): string[]

Inherited from WebdaTerminal.getLogo

Retrieve current logo

Usefull to add some versions

Returns string[]
- Defined in packages/workout/lib/terminal/terminal.d.ts:60

getTrueLength(str: any): number

Inherited from WebdaTerminal.getTrueLength

Parameters
- str: any
Returns number
- Defined in packages/workout/lib/terminal/terminal.d.ts:41

handleTitleMessage(msg: WorkerMessage): void

Overrides Terminal.handleTitleMessage

Parameters
- msg: WorkerMessage
Returns void
- Defined in packages/shell/src/console/terminal.ts:20

log(groups: any, level: WorkerLogLevel, ...args: any[]): void

Inherited from WebdaTerminal.log

Parameters
- groups: any
- level: WorkerLogLevel
- Rest ...args: any[]
Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:37

pushHistory(line: any): void

Inherited from WebdaTerminal.pushHistory

Parameters
- line: any
Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:34

resetTerm(...args: any[]): void

Inherited from WebdaTerminal.resetTerm

Parameters
- Rest ...args: any[]
Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:32

router(msg: WorkerMessage): Promise<void>

Inherited from WebdaTerminal.router

Parameters
- msg: WorkerMessage
Returns Promise<void>
- Defined in packages/workout/lib/terminal/terminal.d.ts:35

scrollDown(increment: number): void

Inherited from WebdaTerminal.scrollDown

Parameters
- increment: number
Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:30

scrollUp(increment: number): void

Inherited from WebdaTerminal.scrollUp

Parameters
- increment: number
Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:29

setDefaultLogo(): void

Returns void
- Defined in packages/shell/src/console/terminal.ts:24

setLogo(logo: string[]): void

Inherited from WebdaTerminal.setLogo

Set the logo to display

How to create logo:

Parameters
- logo: string[]
  
  to display
Returns void
- Defined in packages/workout/lib/terminal/terminal.d.ts:54

setTitle(title?: string): void

Overrides Terminal.setTitle

Parameters
- Default value title: string = ""
Returns void
- Defined in packages/shell/src/console/terminal.ts:57

stripColorString(str: any, limit: number): string

Inherited from WebdaTerminal.stripColorString

Parameters
- str: any
- limit: number
Returns string
- Defined in packages/workout/lib/terminal/terminal.d.ts:39

webdaize(str: any): any

Parameters
- str: any
Returns any
- Defined in packages/shell/src/console/terminal.ts:69

Generated using TypeDoc