File tree Expand file tree Collapse file tree
addons/addon-progress/typings Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -8,19 +8,42 @@ import type { Event } from 'vs/base/common/event';
88import type { ProgressState } from '../src/ProgressAddon' ;
99
1010declare 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 ;
You can’t perform that action at this time.
0 commit comments