Module: runtime/mci/codes/ctrl-codes
Control Codes Handler
Summary
| Screen and flow control codes ( | CS, | PA, | DE, etc.) |
Table of contents
Classes
Interfaces
Type Aliases
Variables
Functions
- clearLine
- clearScreen
- clearToEndOfLine
- clearToEndOfScreen
- cursorDown
- cursorLeft
- cursorPosition
- cursorRight
- cursorUp
- hideCursor
- resetAttributes
- restoreCursor
- saveCursor
- showCursor
Type Aliases
ControlCodeAction
Ƭ ControlCodeAction: { sequence: string ; type: "ansi" } | { type: "pause" } | { message?: string ; type: "pause_message" } | { ms: number ; type: "delay" } | { type: "pause_off" } | { type: "pause_on" } | { type: "pause_reset" } | { type: "abort" } | { type: "noop" }
Defined in
core/src/mci/codes/ctrl-codes.ts:29
Variables
controlCodes
• Const controlCodes: ControlCodeDefinition[]
Defined in
core/src/mci/codes/ctrl-codes.ts:47
Functions
clearLine
▸ clearLine(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:215
clearScreen
▸ clearScreen(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:211
clearToEndOfLine
▸ clearToEndOfLine(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:219
clearToEndOfScreen
▸ clearToEndOfScreen(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:223
cursorDown
▸ cursorDown(n?): string
Parameters
| Name | Type | Default value |
|---|---|---|
n |
number |
1 |
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:195
cursorLeft
▸ cursorLeft(n?): string
Parameters
| Name | Type | Default value |
|---|---|---|
n |
number |
1 |
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:203
cursorPosition
▸ cursorPosition(x, y): string
Parameters
| Name | Type |
|---|---|
x |
number |
y |
number |
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:207
cursorRight
▸ cursorRight(n?): string
Parameters
| Name | Type | Default value |
|---|---|---|
n |
number |
1 |
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:199
cursorUp
▸ cursorUp(n?): string
Parameters
| Name | Type | Default value |
|---|---|---|
n |
number |
1 |
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:191
hideCursor
▸ hideCursor(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:235
resetAttributes
▸ resetAttributes(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:243
restoreCursor
▸ restoreCursor(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:231
saveCursor
▸ saveCursor(): string
Returns
string
Defined in
core/src/mci/codes/ctrl-codes.ts:227
showCursor
▸ showCursor(): string
Returns
string