Update addons/addon-progress/typings/addon-progress.d.ts
Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
This commit is contained in:
+26
-3
@@ -8,19 +8,42 @@ import type { Event } from 'vs/base/common/event';
|
|||||||
import type { ProgressState } from '../src/ProgressAddon';
|
import type { ProgressState } from '../src/ProgressAddon';
|
||||||
|
|
||||||
declare module '@xterm/addon-progress' {
|
declare module '@xterm/addon-progress' {
|
||||||
/** xterm.js addon providing an interface for ConEmu's progress sequence */
|
/**
|
||||||
|
* An xterm.js addon that provides an interface for ConEmu's progress
|
||||||
|
* sequence.
|
||||||
|
*/
|
||||||
export class ProgressAddon implements ITerminalAddon, IDisposable {
|
export class ProgressAddon implements ITerminalAddon, IDisposable {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new progress addon
|
||||||
|
*/
|
||||||
constructor();
|
constructor();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Activates the addon
|
||||||
|
* @param terminal The terminal the addon is being loaded in.
|
||||||
|
*/
|
||||||
public activate(terminal: Terminal): void;
|
public activate(terminal: Terminal): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disposes the addon.
|
||||||
|
*/
|
||||||
public dispose(): void;
|
public dispose(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An event that fires when the tracked progress changes.
|
||||||
|
*/
|
||||||
public readonly onChange: Event<IProgress> | undefined;
|
public readonly onChange: Event<IProgress> | undefined;
|
||||||
|
|
||||||
/** getter / setter for current progress */
|
/**
|
||||||
|
* Gets or sets the current progress tracked by the addon.
|
||||||
|
*/
|
||||||
public progress: IProgress;
|
public progress: IProgress;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** progress object interface */
|
/**
|
||||||
|
* Progress tracked by the addon.
|
||||||
|
*/
|
||||||
export interface IProgress {
|
export interface IProgress {
|
||||||
state: ProgressState;
|
state: ProgressState;
|
||||||
value: number;
|
value: number;
|
||||||
|
|||||||
Reference in New Issue
Block a user