Interface Terminal
interface Terminal {
addons: Map<string, ITerminalAddon>;
ansi: {
style: {
bold: string;
cyan: string;
gray: string;
green: string;
red: string;
reset: string;
yellow: string;
[key: string]: string;
};
};
cmd: string;
commands: Record<string, TerminalCommand>;
cwd: string;
emojis: any;
events: any;
id: string;
promptTemplate: string;
socket?: WebSocket;
socketKey?: JsonWebKey;
stderr: WritableStream<Uint8Array>;
stdin: ReadableStream<Uint8Array>;
stdout: WritableStream<Uint8Array>;
attachShell(shell: Shell): void;
clearCommand(): string;
clearHistory(uid: number): Promise<void>;
connect(socket: WebSocket): void;
createSpecialLink(uri: string, text: string): string;
dispatchStdin(key: string): void;
getInputStream(): ReadableStream<Uint8Array>;
getInputStreamWithClose(): {
close: () => void;
stream: ReadableStream<Uint8Array>;
};
hide(): void;
listen(): void;
mount(element: HTMLElement): void;
paste(data?: string): Promise<void>;
prompt(text?: string): string;
readline(
prompt?: string,
hide?: boolean,
noListen?: boolean,
): Promise<string>;
reloadHistory(uid: number): Promise<void>;
restoreCommand(cmd: string): void;
show(): void;
spinner(spinner: string, prefix?: string, suffix?: string): any;
unlisten(): void;
write(data: string | Uint8Array): void;
writeln(data: string | Uint8Array): void;
}
addons: Map<string, ITerminalAddon>;
ansi: {
style: {
bold: string;
cyan: string;
gray: string;
green: string;
red: string;
reset: string;
yellow: string;
[key: string]: string;
};
};
cmd: string;
commands: Record<string, TerminalCommand>;
cwd: string;
emojis: any;
events: any;
id: string;
promptTemplate: string;
socket?: WebSocket;
socketKey?: JsonWebKey;
stderr: WritableStream<Uint8Array>;
stdin: ReadableStream<Uint8Array>;
stdout: WritableStream<Uint8Array>;
attachShell(shell: Shell): void;
clearCommand(): string;
clearHistory(uid: number): Promise<void>;
connect(socket: WebSocket): void;
createSpecialLink(uri: string, text: string): string;
dispatchStdin(key: string): void;
getInputStream(): ReadableStream<Uint8Array>;
getInputStreamWithClose(): {
close: () => void;
stream: ReadableStream<Uint8Array>;
};
hide(): void;
listen(): void;
mount(element: HTMLElement): void;
paste(data?: string): Promise<void>;
prompt(text?: string): string;
readline(
prompt?: string,
hide?: boolean,
noListen?: boolean,
): Promise<string>;
reloadHistory(uid: number): Promise<void>;
restoreCommand(cmd: string): void;
show(): void;
spinner(spinner: string, prefix?: string, suffix?: string): any;
unlisten(): void;
write(data: string | Uint8Array): void;
writeln(data: string | Uint8Array): void;
}
Hierarchy
- Terminal
- Terminal
Index
Properties
Methods
Properties
Readonlyaddons
Get terminal addons
Readonlyansi
ansi: {
style: {
bold: string;
cyan: string;
gray: string;
green: string;
red: string;
reset: string;
yellow: string;
[key: string]: string;
};
}
style: {
bold: string;
cyan: string;
gray: string;
green: string;
red: string;
reset: string;
yellow: string;
[key: string]: string;
};
}
Get ANSI escape sequences
Readonlycmd
cmd: string
Get current command
Readonlycommands
Get terminal commands
Readonlycwd
cwd: string
Get current working directory
Readonlyemojis
emojis: any
Get emoji utilities
Readonlyevents
events: any
Get event emitter
Readonlyid
id: string
Get terminal ID
promptTemplate
promptTemplate: string
Get/set prompt template
Optional Readonlysocket
Get WebSocket connection
Optional ReadonlysocketKey
Get socket public key
Readonlystderr
Get standard error stream
Readonlystdin
Get standard input stream
Readonlystdout
Get standard output stream
Methods
attachShell
clearCommand
clearHistory
connect
createSpecialLink
dispatchStdin
getInputStream
- getInputStream(): ReadableStream<Uint8Array>
Get input stream
Returns ReadableStream<Uint8Array>
getInputStreamWithClose
- getInputStreamWithClose(): {
close: () => void;
stream: ReadableStream<Uint8Array>;
} Get a new input stream with a close function to signal EOF. Use this when you need to close the stream gracefully (e.g., for Ctrl+D).
Returns { close: () => void; stream: ReadableStream<Uint8Array> }
hide
listen
mount
- mount(element: HTMLElement): void
Mount terminal to DOM element
Parameters
- element: HTMLElement
Element to mount to
Returns void
- element: HTMLElement
paste
prompt
readline
reloadHistory
restoreCommand
show
spinner
unlisten
write
- write(data: string | Uint8Array): void
Write text to terminal
Parameters
- data: string | Uint8Array
Text to write
Returns void
- data: string | Uint8Array
writeln
- writeln(data: string | Uint8Array): void
Write line to terminal
Parameters
- data: string | Uint8Array
Text to write
Returns void
- data: string | Uint8Array
Interface for terminal functionality