Skip to content

docs: document ITerminalOptions scrollback default #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasK33 merged 1 commit into from
Jun 26, 2026
Merged

docs: document ITerminalOptions scrollback default #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export interface ITerminalOptions {
cursorBlink?: boolean; // Default: false
cursorStyle?: 'block' | 'underline' | 'bar';
theme?: ITheme;
scrollback?: number; // Default: 1000
scrollback?: number; // Default: 10000
fontSize?: number; // Default: 15
fontFamily?: string; // Default: 'monospace'
allowTransparency?: boolean;
Expand Down
12 changes: 12 additions & 0 deletions lib/terminal.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2332,6 +2332,18 @@ describe('Public Mutable Options', () => {
expect(term.options.scrollback).toBe(5000);
});

test('options expose default values when none are provided', async () => {
const term = await createIsolatedTerminal();
try {
expect(term.options).toBeDefined();
expect(term.options.cols).toBe(80);
expect(term.options.rows).toBe(24);
expect(term.options.scrollback).toBe(10000);
} finally {
term.dispose();
}
});

test('options can be mutated at runtime', async () => {
const term = await createIsolatedTerminal();
expect(term.options.disableStdin).toBe(false);
Expand Down
Loading