Interface Task<T>

A "named function wrapper" with built in "computation tree progress tracking".

Type Parameters

T

Hierarchy

Task

Index

Properties

Methods

run runAsChild runInContext

Properties

`Readonly` id

id: number

`Readonly` name

name: string

Methods

run

run(): Promise<T>
run the task without observation

Returns Promise<T>
- Defined in node_modules/molstar/lib/mol-task/task.d.ts:11
run(observer: <internal>.Progress.Observer, updateRateMs?: number): Promise<T>
run the task with the specified observer, default updateRate is 250ms
Parameters
- observer: <internal>.Progress.Observer
- Optional updateRateMs: number
Returns Promise<T>
- Defined in node_modules/molstar/lib/mol-task/task.d.ts:13

runAsChild

runAsChild(ctx: RuntimeContext, progress?: string | Partial<ProgressUpdate>): Promise<T>
Run a child task that adds a new node to the progress tree. Allows to passing the progress so that the progress tree can be kept in a "good state" without having to separately call update.
Parameters
- ctx: RuntimeContext
- Optional progress: string | Partial<ProgressUpdate>
Returns Promise<T>
- Defined in node_modules/molstar/lib/mol-task/task.d.ts:18

runInContext

runInContext(ctx: RuntimeContext): Promise<T>
Run the task on the specified context.
Parameters
- ctx: RuntimeContext
Returns Promise<T>
- Defined in node_modules/molstar/lib/mol-task/task.d.ts:20

Generated using TypeDoc