Required options

This commit is contained in:
Simon Lamon
2022-08-05 16:16:12 +00:00
parent c021571194
commit a1385f589b
17 changed files with 84 additions and 82 deletions
+7 -6
View File
@@ -84,7 +84,7 @@ declare module 'xterm-headless' {
/**
* The modifier key hold to multiply scroll speed.
*/
fastScrollModifier?: 'alt' | 'ctrl' | 'shift' | undefined;
fastScrollModifier?: 'none' | 'alt' | 'ctrl' | 'shift';
/**
* The spacing in whole pixels between characters.
@@ -538,11 +538,12 @@ declare module 'xterm-headless' {
* ```typescript
* console.log(terminal.options.fontSize);
* ```
*/
get options(): Required<ITerminalOptions>;
/**
* Gets or sets the terminal options. This supports setting multiple options.
*
* @example Set a single option
* ```typescript
* terminal.options.fontSize = 12;
* ```
*
* @example Set multiple options
* ```typescript
@@ -552,7 +553,7 @@ declare module 'xterm-headless' {
* };
* ```
*/
options: ITerminalOptions;
set options(options: ITerminalOptions);
/**
* Natural language strings that can be localized.
+8 -7
View File
@@ -91,7 +91,7 @@ declare module 'xterm' {
/**
* The modifier key hold to multiply scroll speed.
*/
fastScrollModifier?: 'alt' | 'ctrl' | 'shift' | undefined;
fastScrollModifier?: 'none' | 'alt' | 'ctrl' | 'shift';
/**
* The scroll speed multiplier used for fast scrolling.
@@ -700,11 +700,12 @@ declare module 'xterm' {
* ```typescript
* console.log(terminal.options.fontSize);
* ```
*/
get options(): Required<ITerminalOptions>;
/**
* Gets or sets the terminal options. This supports setting multiple options.
*
* @example Set a single option
* ```typescript
* terminal.options.fontSize = 12;
* ```
*
* @example Set multiple options
* ```typescript
@@ -714,7 +715,7 @@ declare module 'xterm' {
* };
* ```
*/
options: ITerminalOptions;
set options(options: ITerminalOptions);
/**
* Natural language strings that can be localized.
@@ -1069,7 +1070,7 @@ declare module 'xterm' {
/**
* An object representing a range within the viewport of the terminal.
*/
export interface IViewportRange {
export interface IViewportRange {
/**
* The start of the range.
*/