listr.d.ts 1.5 KB

123456789101112131415161718192021222324
  1. import { ListrError } from './interfaces/listr-error.interface';
  2. import { ListrBaseClassOptions, ListrContext, ListrTask } from './interfaces/listr.interface';
  3. import { ListrDefaultRendererValue, ListrFallbackRendererValue, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrRendererFactory, ListrRendererValue } from './interfaces/renderer.interface';
  4. import { Task } from './lib/task';
  5. /**
  6. * Creates a new set of Listr2 task list.
  7. */
  8. export declare class Listr<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrDefaultRendererValue, FallbackRenderer extends ListrRendererValue = ListrFallbackRendererValue> {
  9. task: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[];
  10. options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>;
  11. tasks: Task<Ctx, ListrGetRendererClassFromValue<Renderer>>[];
  12. err: ListrError<Ctx>[];
  13. ctx: Ctx;
  14. rendererClass: ListrRendererFactory;
  15. rendererClassOptions: ListrGetRendererOptions<ListrRendererFactory>;
  16. renderHook$: Task<any, any>['renderHook$'];
  17. private concurrency;
  18. private renderer;
  19. constructor(task: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[], options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>);
  20. add(task: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[]): void;
  21. run(context?: Ctx): Promise<Ctx>;
  22. private checkAll;
  23. private runTask;
  24. }