External module "progress/index"

Index

Interfaces

Type aliases

Functions

withProgress

Type aliases

ProgressResult

ProgressResult: TResult | PromiseLike<TResult>

A progress result.

ProgressTask

ProgressTask: function

A progress task.

param: The underlying context.
returns: The result.

Type declaration

- (context: ProgressContext): ProgressResult<TResult>
- Parameters
  - context: ProgressContext
  Returns ProgressResult<TResult>

Functions

withProgress

withProgress<TResult>(task: ProgressTask<TResult>, options?: ProgressOptions): Promise<TResult>

- Defined in progress/index.ts:93
Runs a task with progress information.

Type parameters
- TResult
Parameters
- task: ProgressTask<TResult>
  
  The task to execute.
- Optional options: ProgressOptions
Returns Promise<TResult>

The promise with the result.

Generated using TypeDoc