task.d.ts 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. import { Subject } from 'rxjs';
  2. import { ListrRendererFactory, ListrGetRendererTaskOptions, ListrContext, ListrEvent, ListrOptions, ListrTask, ListrTaskObject, ListrTaskWrapper, PromptError, ListrGetRendererOptions, StateConstants } from '../interfaces/listr.interface';
  3. import { Listr } from '../index';
  4. export declare class Task<Ctx, Renderer extends ListrRendererFactory> extends Subject<ListrEvent> implements ListrTaskObject<ListrContext, Renderer> {
  5. listr: Listr<Ctx, any, any>;
  6. tasks: ListrTask<Ctx, any>;
  7. options: ListrOptions;
  8. rendererOptions: ListrGetRendererOptions<Renderer>;
  9. id: ListrTaskObject<Ctx, Renderer>['id'];
  10. cleanTitle: ListrTaskObject<Ctx, Renderer>['cleanTitle'];
  11. task: ListrTaskObject<Ctx, Renderer>['task'];
  12. skip: ListrTaskObject<Ctx, Renderer>['skip'];
  13. subtasks: ListrTaskObject<Ctx, any>['subtasks'];
  14. state: ListrTaskObject<Ctx, Renderer>['state'];
  15. output: ListrTaskObject<Ctx, Renderer>['output'];
  16. title: ListrTaskObject<Ctx, Renderer>['title'];
  17. message: ListrTaskObject<Ctx, Renderer>['message'];
  18. prompt: boolean | PromptError;
  19. exitOnError: boolean;
  20. rendererTaskOptions: ListrGetRendererTaskOptions<Renderer>;
  21. renderHook$: Subject<void>;
  22. private enabled;
  23. private enabledFn;
  24. constructor(listr: Listr<Ctx, any, any>, tasks: ListrTask<Ctx, any>, options: ListrOptions, rendererOptions: ListrGetRendererOptions<Renderer>);
  25. set state$(state: StateConstants);
  26. set output$(data: string);
  27. set message$(data: ListrTaskObject<Ctx, Renderer>['message']);
  28. set title$(title: string);
  29. check(ctx: Ctx): Promise<void>;
  30. hasSubtasks(): boolean;
  31. isPending(): boolean;
  32. isSkipped(): boolean;
  33. isCompleted(): boolean;
  34. hasFailed(): boolean;
  35. isEnabled(): boolean;
  36. hasTitle(): boolean;
  37. isPrompt(): boolean;
  38. run(context: Ctx, wrapper: ListrTaskWrapper<Ctx, Renderer>): Promise<void>;
  39. }