Interface: IQOutput

core/output.IQOutput

IQOutput - Abstract interface for output operations This allows the core package to be decoupled from the Session implementation

Table of contents

Methods

• clearInputQueue
• close
• getEncoding
• getHeight
• getLineCount
• getMCIProcessor
• getNextSnack
• getPendingActions
• getWidth
• hasInput
• incrementLineCount
• isPauseAborted
• isPauseEnabled
• processMCI
• pushSnack
• readKey
• readKeyNonBlocking
• readLine
• resetLineCount
• setEncoding
• setMCIContext
• setPauseAborted
• setPauseEnabled
• setSyncTermFont
• setUsername
• supportsFonts
• waitKey
• write
• writeMCI

Methods

clearInputQueue

▸ Optional clearInputQueue(): void

Clear pending input and any partial escape sequence (optional; Session implements it).

Returns

void

Defined in

core/src/output.ts:55

---

close

▸ close(): void

Returns

void

Defined in

core/src/output.ts:96

---

getEncoding

▸ Optional getEncoding(): "cp437" | "utf8"

Returns

"cp437" | "utf8"

Defined in

core/src/output.ts:92

---

getHeight

▸ getHeight(): number

Returns

number

Defined in

core/src/output.ts:34

---

getLineCount

▸ getLineCount(): number

Returns

number

Defined in

core/src/output.ts:78

---

getMCIProcessor

▸ getMCIProcessor(): MCIProcessor

Returns

MCIProcessor

Defined in

core/src/output.ts:73

---

getNextSnack

▸ Optional getNextSnack(): null | { corner: string ; durationMs: number ; message: string }

Pop and return the next snack from the session queue (optional; Session implements it).

Returns

null | { corner: string ; durationMs: number ; message: string }

Defined in

core/src/output.ts:65

---

getPendingActions

▸ getPendingActions(): ControlCodeAction[]

Returns

ControlCodeAction[]

Defined in

core/src/output.ts:85

---

getWidth

▸ getWidth(): number

Returns

number

Defined in

core/src/output.ts:33

---

hasInput

▸ hasInput(): boolean

Check if input is available without blocking

Returns

boolean

Defined in

core/src/output.ts:50

---

incrementLineCount

▸ incrementLineCount(count): void

Parameters

Name	Type
count	number

Returns

void

Defined in

core/src/output.ts:80

---

isPauseAborted

▸ isPauseAborted(): boolean

Returns

boolean

Defined in

core/src/output.ts:81

---

isPauseEnabled

▸ isPauseEnabled(): boolean

Returns

boolean

Defined in

core/src/output.ts:83

---

processMCI

▸ processMCI(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

core/src/output.ts:74

---

pushSnack

▸ Optional pushSnack(payload): void

Push a snack onto the session queue (optional; Session implements it).

Parameters

Name	Type
payload	Object
payload.corner	string
payload.durationMs	number
payload.message	string

Returns

void

Defined in

core/src/output.ts:60

---

readKey

▸ readKey(): Promise<string>

Returns

Promise<string>

Defined in

core/src/output.ts:38

---

readKeyNonBlocking

▸ readKeyNonBlocking(): null | string

Non-blocking key read - returns immediately

Returns

null | string

The key pressed, or null if no input available

Defined in

core/src/output.ts:45

---

readLine

▸ readLine(): Promise<string>

Returns

Promise<string>

Defined in

core/src/output.ts:39

---

resetLineCount

▸ resetLineCount(): void

Returns

void

Defined in

core/src/output.ts:79

---

setEncoding

▸ Optional setEncoding(encoding): void

Parameters

Name	Type
encoding	"cp437" | "utf8"

Returns

void

Defined in

core/src/output.ts:93

---

setMCIContext

▸ setMCIContext(ctx): void

Parameters

Name	Type
ctx	any

Returns

void

Defined in

core/src/output.ts:75

---

setPauseAborted

▸ setPauseAborted(aborted): void

Parameters

Name	Type
aborted	boolean

Returns

void

Defined in

core/src/output.ts:82

---

setPauseEnabled

▸ setPauseEnabled(enabled): void

Parameters

Name	Type
enabled	boolean

Returns

void

Defined in

core/src/output.ts:84

---

setSyncTermFont

▸ Optional setSyncTermFont(fontName): void

Parameters

Name	Type
fontName	string

Returns

void

Defined in

core/src/output.ts:89

---

setUsername

▸ Optional setUsername(handle): void

Set the session username for snack targeting by user (optional; Session implements it).

Parameters

Name	Type
handle	undefined | string

Returns

void

Defined in

core/src/output.ts:70

---

supportsFonts

▸ Optional supportsFonts(): boolean

Returns

boolean

Defined in

core/src/output.ts:88

---

waitKey

▸ waitKey(): Promise<string>

Returns

Promise<string>

Defined in

core/src/output.ts:37

---

write

▸ write(data): void

Parameters

Name	Type
data	string

Returns

void

Defined in

core/src/output.ts:29

---

writeMCI

▸ writeMCI(data): void

Parameters

Name	Type
data	string

Returns

void

Defined in

core/src/output.ts:30