Skip to content

Commit 75e5cc1

Browse files
jerchTyriar
andauthored
Update addons/addon-progress/typings/addon-progress.d.ts
Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
1 parent 6a23276 commit 75e5cc1

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

addons/addon-progress/typings/addon-progress.d.ts

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,42 @@ import type { Event } from 'vs/base/common/event';
88
import type { ProgressState } from '../src/ProgressAddon';
99

1010
declare module '@xterm/addon-progress' {
11-
/** xterm.js addon providing an interface for ConEmu's progress sequence */
11+
/**
12+
* An xterm.js addon that provides an interface for ConEmu's progress
13+
* sequence.
14+
*/
1215
export class ProgressAddon implements ITerminalAddon, IDisposable {
16+
17+
/**
18+
* Creates a new progress addon
19+
*/
1320
constructor();
21+
22+
/**
23+
* Activates the addon
24+
* @param terminal The terminal the addon is being loaded in.
25+
*/
1426
public activate(terminal: Terminal): void;
27+
28+
/**
29+
* Disposes the addon.
30+
*/
1531
public dispose(): void;
1632

33+
/**
34+
* An event that fires when the tracked progress changes.
35+
*/
1736
public readonly onChange: Event<IProgress> | undefined;
1837

19-
/** getter / setter for current progress */
38+
/**
39+
* Gets or sets the current progress tracked by the addon.
40+
*/
2041
public progress: IProgress;
2142
}
2243

23-
/** progress object interface */
44+
/**
45+
* Progress tracked by the addon.
46+
*/
2447
export interface IProgress {
2548
state: ProgressState;
2649
value: number;

0 commit comments

Comments
 (0)