listr2

Appearance

Documentation / @listr2/manager / Manager

Class: Manager<Ctx, Renderer, FallbackRenderer> ​

Defined in: manager.ts:21

Creates a new Listr2 task manager.

Useful for creating a single instance of Listr2 with pre-set settings.

See ​

https://listr2.kilic.dev/listr/manager.html

Type Parameters ​

Ctx ​

Ctx = ListrContext

Renderer ​

Renderer extends ListrRendererValue = ListrPrimaryRendererValue

FallbackRenderer ​

FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue

Constructors ​

Constructor ​

new Manager<Ctx, Renderer, FallbackRenderer>(options?): Manager<Ctx, Renderer, FallbackRenderer>

Defined in: manager.ts:29

Parameters ​

options? ​

ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>

Returns ​

Manager<Ctx, Renderer, FallbackRenderer>

Properties ​

errors ​

errors: ListrError<any>[] = []

Defined in: manager.ts:26

tasks ​

tasks: ListrTask<any, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] = []

Defined in: manager.ts:27

options? ​

optional options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>

Defined in: manager.ts:29

Accessors ​

ctx ​

Get Signature ​

get ctx(): Ctx

Defined in: manager.ts:31

Returns ​

Ctx

Set Signature ​

set ctx(ctx): void

Defined in: manager.ts:35

Parameters ​
ctx ​

Ctx

Returns ​

void

Methods ​

add() ​

add<InjectCtx>(tasks, options?): void

Defined in: manager.ts:39

Type Parameters ​

InjectCtx ​

InjectCtx = Ctx

Parameters ​

tasks ​

ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[])

options? ​

ListrSubClassOptions<InjectCtx, Renderer, FallbackRenderer>

Returns ​

void

runAll() ​

runAll<InjectCtx>(options?): Promise<InjectCtx>

Defined in: manager.ts:48

Type Parameters ​

InjectCtx ​

InjectCtx = Ctx

Parameters ​

options? ​

ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>

Returns ​

Promise<InjectCtx>

newListr() ​

newListr<InjectCtx, InjectRenderer, InjectFallbackRenderer>(tasks, options?): Listr<InjectCtx, InjectRenderer, InjectFallbackRenderer>

Defined in: manager.ts:61

Type Parameters ​

InjectCtx ​

InjectCtx = Ctx

InjectRenderer ​

InjectRenderer extends ListrRendererValue = Renderer

InjectFallbackRenderer ​

InjectFallbackRenderer extends ListrRendererValue = FallbackRenderer

Parameters ​

tasks ​

ListrTask<InjectCtx, ListrGetRendererClassFromValue<InjectRenderer>, ListrGetRendererClassFromValue<InjectFallbackRenderer>>[]

options? ​

ListrBaseClassOptions<InjectCtx, InjectRenderer, InjectFallbackRenderer>

Returns ​

Listr<InjectCtx, InjectRenderer, InjectFallbackRenderer>

indent() ​

indent<InjectCtx>(tasks, options?, taskOptions?): ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>

Defined in: manager.ts:68

Type Parameters ​

InjectCtx ​

InjectCtx = Ctx

Parameters ​

tasks ​

ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[])

options? ​

ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>

taskOptions? ​

Omit<ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>, "task">

Returns ​

ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>

run() ​

run<InjectCtx>(tasks, options?): Promise<InjectCtx>

Defined in: manager.ts:91

Type Parameters ​

InjectCtx ​

InjectCtx = Ctx

Parameters ​

tasks ​

ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]

options? ​

ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>

Returns ​

Promise<InjectCtx>