Parameters
- wo: WorkerOutput
- Default value level: WorkerLogLevel = undefined
- Default value format: string = undefined
- Default value tty: boolean = process.stdout.isTTY
Returns Terminal
- Defined in packages/workout/src/terminal/terminal.ts:39

Properties

_refresh: Timeout

format: string

hasProgress: boolean

height: number

history: string[] = []

historySize: number = 2000

inputValid: boolean = true

inputValue: string = ""

inputs: WorkerInput[] = []

level: WorkerLogLevel

logo: string[] = []

logoWidth: number = 0

progressChar: number = 0

progressChars: string[] = ["\u287F", "\u28BF", "\u28FB", "\u28FD", "\u28FE", "\u28F7", "\u28EF", "\u28DF"].map(c =>colors.bold(colors.yellow(c)))

progresses: object

Type declaration

[key: string]: WorkerProgress

reset: boolean = false

rl: Interface

scrollY: number = -1

title: string = ""

tty: boolean

wo: WorkerOutput

Methods

clearScreen(): void

Returns void
- Defined in packages/workout/src/terminal/terminal.ts:451

close(): void

Returns void
- Defined in packages/workout/src/terminal/terminal.ts:166

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

Parameters
- ratio: any
- barlen: any
Returns string
- Defined in packages/workout/src/terminal/terminal.ts:288

displayFooter(): string

Returns string
- Defined in packages/workout/src/terminal/terminal.ts:335

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

Parameters
- lines: number
- Default value complete: boolean = true
Returns string
- Defined in packages/workout/src/terminal/terminal.ts:382

displayProgress(p: WorkerProgress): string

Parameters
- p: WorkerProgress
Returns string
- Defined in packages/workout/src/terminal/terminal.ts:317

displayScreen(): Promise<void>

Returns Promise<void>
- Defined in packages/workout/src/terminal/terminal.ts:421

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

Parameters
- str: any
- Default value limit: number = undefined
Returns any
- Defined in packages/workout/src/terminal/terminal.ts:271

displayTitle(): string

Returns string
- Defined in packages/workout/src/terminal/terminal.ts:309

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

Parameters
- size: number
- complete: boolean
Returns string
- Defined in packages/workout/src/terminal/terminal.ts:301

getFooterSize(): number

Returns number
- Defined in packages/workout/src/terminal/terminal.ts:236

getLogo(): string[]

Retrieve current logo

Usefull to add some versions

Returns string[]
- Defined in packages/workout/src/terminal/terminal.ts:378

getTrueLength(str: any): number

Parameters
- str: any
Returns number
- Defined in packages/workout/src/terminal/terminal.ts:284

handleTitleMessage(msg: WorkerMessage): void

Parameters
- msg: WorkerMessage
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:209

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

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

pushHistory(line: any): void

Parameters
- line: any
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:175

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

Parameters
- Rest ...args: any[]
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:157

router(msg: WorkerMessage): Promise<void>

Parameters
- msg: WorkerMessage
Returns Promise<void>
- Defined in packages/workout/src/terminal/terminal.ts:182

scrollDown(increment: number): void

Parameters
- increment: number
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:143

scrollUp(increment: number): void

Parameters
- increment: number
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:133

setLogo(logo: string[]): void

Set the logo to display

How to create logo:

Parameters
- logo: string[]
  
  to display
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:363

setTitle(title?: string): void

Parameters
- Default value title: string = ""
Returns void
- Defined in packages/workout/src/terminal/terminal.ts:153

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

Parameters
- str: any
- limit: number
Returns string
- Defined in packages/workout/src/terminal/terminal.ts:247

Generated using TypeDoc

Class Terminal

Hierarchy

Constructors

Properties

Methods

Constructors

Parameters

wo: WorkerOutput

Default value level: WorkerLogLevel = undefined

Default value format: string = undefined

Default value tty: boolean = process.stdout.isTTY

Returns Terminal

Properties

Type declaration

[key: string]: WorkerProgress

Methods

Returns void

Returns void

Parameters

ratio: any

barlen: any

Returns string

Returns string

Parameters

lines: number

Default value complete: boolean = true

Returns string

Parameters

p: WorkerProgress

Returns string

Returns Promise<void>

Parameters

str: any

Default value limit: number = undefined

Returns any

Returns string

Parameters

size: number

complete: boolean

Returns string

Returns number

Returns string[]

Parameters

str: any

Returns number

Parameters

msg: WorkerMessage

Returns void

Parameters

groups: any

level: WorkerLogLevel

Rest ...args: any[]

Returns void

Parameters

line: any

Returns void

Parameters

Rest ...args: any[]

Returns void

Parameters

msg: WorkerMessage

Returns Promise<void>

Parameters

increment: number

Returns void

Parameters

increment: number

Returns void

Parameters

logo: string[]

Returns void

Parameters

Default value title: string = ""

Returns void

Parameters

str: any

limit: number

Returns string