simple.renderer.d.ts 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. import { ListrEventType } from '../constants/event.constants';
  2. import { ListrEventFromType } from '../interfaces/listr.interface';
  3. import { ListrRenderer } from '../interfaces/renderer.interface';
  4. import { Task } from '../lib/task';
  5. /**
  6. * This is the default renderer which is neither verbose or updating.
  7. * It provides short output like update renderer, but does not disturb
  8. * stdin during execution of listr tasks
  9. */
  10. export declare class SimpleRenderer implements ListrRenderer {
  11. readonly tasks: Task<any, typeof SimpleRenderer>[];
  12. options: typeof SimpleRenderer['rendererOptions'];
  13. static nonTTY: boolean;
  14. static rendererOptions: {
  15. /**
  16. * if true this will add
  17. * timestamp at the begin of the rendered line
  18. *
  19. * @example
  20. *
  21. * ```bash
  22. * [12:33:44] ✔ Do something important
  23. * ```
  24. *
  25. * @default false
  26. */
  27. prefixWithTimestamp?: boolean;
  28. /**
  29. * choose between process.stdout and process.stderr
  30. *
  31. * @default stdout
  32. */
  33. output?: 'stdout' | 'stderr';
  34. };
  35. static rendererTaskOptions: never;
  36. /**
  37. * Event type renderer map contains functions to process different task events
  38. */
  39. eventTypeRendererMap: Partial<{
  40. [P in ListrEventType]: (t: Task<any, typeof SimpleRenderer>, event: ListrEventFromType<P>) => void;
  41. }>;
  42. constructor(tasks: Task<any, typeof SimpleRenderer>[], options: typeof SimpleRenderer['rendererOptions']);
  43. static now(): Date;
  44. static formatTitle(task?: Task<any, typeof SimpleRenderer>): string;
  45. log(output?: string): void;
  46. end(): void;
  47. render(tasks?: Task<any, typeof SimpleRenderer>[]): void;
  48. }