Class Progress

Progress helper with these properties:

totalUnits and completedUnits for progress
Can be cancelled
Sends events on cancel, changed and dispose
Supports children and propagates values. Total progress is sum of all units in the tree.
On dispose child removes itself from parent.

Hierarchy (View Summary)

Emitter<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 },
>
- Progress

Constructors

constructor

new Progress(opt?: ProgressOptions): Progress
Parameters
- opt: ProgressOptions = {}
Returns Progress
Overrides Emitter.constructor
- Defined in common/exec/progress.ts:39

Properties

_logEmitter

_logEmitter: LoggerInterface = ...

call

call: {
    progressCancelled: (progress: Progress) => void;
    progressChanged: (progress: Progress) => void;
    progressDispose: (progress: Progress) => void;
} = ...

RPC like emitting of events.

dispose

dispose: (strictSync?: boolean) => void | Promise<any> & {
 add: (obj?: Disposer) => DisposerFunction | undefined;
 dispose: (strictSync?: boolean) => void | Promise<any>;
 disposed: number;
 disposeSync: () => void;
 exec: (strictSync?: boolean) => void | Promise<any>;
 remove: (disposable: Disposer) => void | Promise<void>;
 sync: () => void;
 track: (obj?: Disposer) => DisposerFunction | undefined;
 untrack: (disposable: Disposer) => void | Promise<void>;
 "[asyncDispose]"(): Promise<any>;
 "[dispose]"(): void | Promise<any>;
 getSize(): number;
 isDisposed(): boolean;
} = ...

Type Declaration

- (strictSync?: boolean): void | Promise<any>
- Dispose all tracked entries
 Parameters
 - strictSync: boolean = false
 Returns void | Promise<any>

add: (obj?: Disposer) => DisposerFunction | undefined
dispose: (strictSync?: boolean) => void | Promise<any>
disposed: number
Counter that incremends, each time dispose has been called
disposeSync: () => void
exec: (strictSync?: boolean) => void | Promise<any>
Deprecated
use dispose
remove: (disposable: Disposer) => void | Promise<void>
sync: () => void
track: (obj?: Disposer) => DisposerFunction | undefined
Deprecated
use add
untrack: (disposable: Disposer) => void | Promise<void>
Deprecated
use remove
[asyncDispose]: function
- "[asyncDispose]"(): Promise<any>
 Returns Promise<any>
 - Defined in common/dispose-defer.ts:134
[dispose]: function
- "[dispose]"(): void | Promise<any>
 Returns void | Promise<any>
 - Defined in common/dispose-defer.ts:130
getSize: function
- getSize(): number
  Returns number
  - Defined in common/dispose-defer.ts:123
isDisposed: function
- isDisposed(): boolean
  Returns boolean
  - Defined in common/dispose-defer.ts:126

name

name: string

Methods

addChild

addChild(child: Progress): void
Add child progress, which count into its parents units. On dispose it will auto remove itself from parent.
Parameters
- child: Progress
Returns void
- Defined in common/exec/progress.ts:87

addEventListener

addEventListener(
 event: U,
 fn: DefaultListener[U],
 opt?: EmitterSubscriberOptions,
): DisposerFunction
Type Parameters
- U extends string | number
Parameters
- event: U
- fn: DefaultListener[U]
- opt: EmitterSubscriberOptions = {}
Returns DisposerFunction
Inherited from Emitter.addEventListener
- Defined in common/msg/emitter.ts:202

cancel

cancel(): Promise<void>
Notify and mark as cancelled. May take some time before having an effect.

Returns Promise<void>
- Defined in common/exec/progress.ts:76

createChildProgress

createChildProgress(opt?: ProgressOptions): Progress
Create child progress.
Parameters
- Optionalopt: ProgressOptions
Returns Progress
- Defined in common/exec/progress.ts:96

emit

emit(
 event: U,
 ...args: Parameters<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >,
): Promise<boolean>
Emits an event to all subscribers and executes their corresponding event handlers.
Type Parameters
- U extends "progressCancelled" | "progressChanged" | "progressDispose"
Parameters
- event: U
 The event to emit.
- ...args: Parameters<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >
 The arguments to pass to the event handlers.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the event was successfully emitted.
Inherited from Emitter.emit
- Defined in common/msg/emitter.ts:105

get

get(
 event: U,
 ...args: Parameters<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >,
): Promise<
 | ReturnType<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >
 | undefined,
>
Emits an event to all subscribers and executes their corresponding event handlers.
Type Parameters
- U extends "progressCancelled" | "progressChanged" | "progressDispose"
Parameters
- event: U
 The event to emit.
- ...args: Parameters<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >
 The arguments to pass to the event handlers.
Returns Promise<
 | ReturnType<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >
 | undefined,
>
A promise that resolves to the result of the first subscriber's handler, or undefined if no subscribers are present.
Inherited from Emitter.get
- Defined in common/msg/emitter.ts:90

getAll

getAll(
 event: U,
 ...args: Parameters<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >,
): Promise<
 | ReturnType<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >[]
 | undefined,
>
Emits an event to all subscribers and executes their corresponding event handlers.
Type Parameters
- U extends "progressCancelled" | "progressChanged" | "progressDispose"
Parameters
- event: U
 The event to emit.
- ...args: Parameters<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >
 The arguments to pass to the event handlers.
Returns Promise<
 | ReturnType<
 {
 progressCancelled: (progress: Progress) => void;
 progressChanged: (progress: Progress) => void;
 progressDispose: (progress: Progress) => void;
 }[U],
 >[]
 | undefined,
>
A promise that resolves to an array of results from all subscribers, or undefined if no subscribers are present.
Inherited from Emitter.getAll
- Defined in common/msg/emitter.ts:57

getChildrenCount

getChildrenCount(): number
Returns number
- Defined in common/exec/progress.ts:152

getCompletedUnits

getCompletedUnits(): number
Completed units including children

Returns number
- Defined in common/exec/progress.ts:118

getFraction

getFraction(): number
Value from 0 to 1, where 1 is 100% completeness.

Returns number
- Defined in common/exec/progress.ts:143

getTotalUnits

getTotalUnits(): number
Total units including children

Returns number
- Defined in common/exec/progress.ts:108

hasListeners

hasListeners(event: string | number): boolean
Parameters
- event: string | number
Returns boolean
Inherited from Emitter.hasListeners
- Defined in common/msg/emitter.ts:175

incCompletedUnits

incCompletedUnits(step?: number): void
Dynamically change completed units.
Parameters
- step: number = 1
Returns void
- Defined in common/exec/progress.ts:183

incTotalUnits

incTotalUnits(step?: number): void
Relatively change total units.
Parameters
- step: number = 1
Returns void
- Defined in common/exec/progress.ts:165

isCancelled

isCancelled(): boolean
Returns boolean
- Defined in common/exec/progress.ts:133

isFinished

isFinished(): boolean
Either disposed or all units completed.

Returns boolean
- Defined in common/exec/progress.ts:138

isIndeterminate

isIndeterminate(): boolean
Cannot calculate progress, because totalUnits are missing. Special representation in UI.

Returns boolean
- Defined in common/exec/progress.ts:129

off

off(event: U, listener: DefaultListener[U]): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from Emitter.off
- Defined in common/msg/emitter.ts:161

on

on(
 event: U,
 fn: DefaultListener[U],
 opt?: EmitterSubscriberOptions,
): DisposerFunction
Type Parameters
- U extends string | number
Parameters
- event: U
- fn: DefaultListener[U]
- opt: EmitterSubscriberOptions = {}
Returns DisposerFunction
Inherited from Emitter.on
- Defined in common/msg/emitter.ts:114

onAny

onAny(fn: EmitterHandler): void
Parameters
- fn: EmitterHandler
Returns void
Inherited from Emitter.onAny
- Defined in common/msg/emitter.ts:110

onCall

onCall(handlers: Partial<LocalListener>): void
Parameters
- handlers: Partial<LocalListener>
Returns void
Inherited from Emitter.onCall
- Defined in common/msg/emitter.ts:142

once

once(
event: U,
listener: DefaultListener[U],
): DisposerFunction
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns DisposerFunction
Inherited from Emitter.once
- Defined in common/msg/emitter.ts:147

removeAllListeners

removeAllListeners(): this
Returns this
Inherited from Emitter.removeAllListeners
- Defined in common/msg/emitter.ts:170

removeChild

removeChild(child: Progress): void
Parameters
- child: Progress
Returns void
- Defined in common/exec/progress.ts:102

removeEventListener

removeEventListener(
event: U,
listener: DefaultListener[U],
): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from Emitter.removeEventListener
- Defined in common/msg/emitter.ts:210

reset

reset(): void
Fresh start

Returns void
- Defined in common/exec/progress.ts:66

setCompleted

setCompleted(): void
Set to 100% without disposing.

Returns void
- Defined in common/exec/progress.ts:177

setCompletetedUnits

setCompletetedUnits(units: number): void
Set fixed number of completed units.
Parameters
- units: number
Returns void
- Defined in common/exec/progress.ts:171

setTotalUnits

setTotalUnits(units: number, completedUnits?: number): void
Change total units.
Parameters
- units: number
- OptionalcompletedUnits: number
Returns void
- Defined in common/exec/progress.ts:157

toString

toString(indent?: number): string
Progress tree to string for debuggin purposes. Consider using name attribute of Progress.
Parameters
- indent: number = 0
Returns string
- Defined in common/exec/progress.ts:189

waitOn

waitOn[0]>(
event: U,
timeoutMS?: number,
): Promise<R>
Type Parameters
- U extends string | number
- R = Parameters<DefaultListener[U]>[0]
Parameters
- event: U
- timeoutMS: number = 1000
Returns Promise<R>
Inherited from Emitter.waitOn
- Defined in common/msg/emitter.ts:181

Class Progress

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Progress

Properties

_logEmitter

call

dispose

Type Declaration

Parameters

Returns void | Promise<any>

add: (obj?: Disposer) => DisposerFunction | undefined

dispose: (strictSync?: boolean) => void | Promise<any>

disposed: number

disposeSync: () => void

exec: (strictSync?: boolean) => void | Promise<any>

Deprecated

remove: (disposable: Disposer) => void | Promise<void>

sync: () => void

track: (obj?: Disposer) => DisposerFunction | undefined

Deprecated

untrack: (disposable: Disposer) => void | Promise<void>

Deprecated

[asyncDispose]: function

Returns Promise<any>

[dispose]: function

Returns void | Promise<any>

getSize: function

Returns number

isDisposed: function

Returns boolean

name

Methods

addChild

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns DisposerFunction

cancel

Returns Promise<void>

createChildProgress

Parameters

Returns Progress

emit

Type Parameters

Parameters

Returns Promise<boolean>

get

Type Parameters

Parameters

Returns Promise< | ReturnType< { progressCancelled: (progress: Progress) => void; progressChanged: (progress: Progress) => void; progressDispose: (progress: Progress) => void; }[U], > | undefined,>

getAll

Type Parameters

Parameters

Returns Promise< | ReturnType< { progressCancelled: (progress: Progress) => void; progressChanged: (progress: Progress) => void; progressDispose: (progress: Progress) => void; }[U], >[] | undefined,>

getChildrenCount

Returns number

getCompletedUnits

Returns number

getFraction

Returns number

getTotalUnits

Returns number

hasListeners

Parameters

Returns boolean

incCompletedUnits

Parameters

Returns void

incTotalUnits

Parameters

Returns void

Returns Promise<
| ReturnType<
{
progressCancelled: (progress: Progress) => void;
progressChanged: (progress: Progress) => void;
progressDispose: (progress: Progress) => void;
}[U],
>
| undefined,
>

Returns Promise<
| ReturnType<
{
progressCancelled: (progress: Progress) => void;
progressChanged: (progress: Progress) => void;
progressDispose: (progress: Progress) => void;
}[U],
>[]
| undefined,
>