Files
xterm.js/addons/addon-progress/typings/addon-progress.d.ts
T
2024-12-15 18:57:03 +01:00

31 lines
855 B
TypeScript

/**
* Copyright (c) 2024 The xterm.js authors. All rights reserved.
* @license MIT
*/
import { Terminal, ITerminalAddon, IDisposable } from '@xterm/xterm';
declare module '@xterm/addon-progress' {
/** xterm.js addon providing an interface for ConEmu's progress sequence */
export class ProgressAddon implements ITerminalAddon {
constructor();
public activate(terminal: Terminal): void;
public dispose(): void;
/** register progress handler */
public register(handler: ProgressHandler): IDisposable;
/** getter / setter for current progress */
public progress: IProgress;
}
/** progress object interface */
export interface IProgress {
state: 0 | 1 | 2 | 3 | 4;
value: number;
}
/** Progress handler type */
export type ProgressHandler = (state: 0 | 1 | 2 | 3 | 4, value: number) => void;
}