task-wrapper.d.ts 1.3 KB

1234567891011121314151617181920212223
  1. /// <reference types="node" />
  2. import { ListrError, ListrRendererFactory, ListrSubClassOptions, ListrTask, ListrTaskWrapper, StateConstants, ListrBaseClassOptions, ListrTaskObject } from '../interfaces/listr.interface';
  3. import { Task } from './task';
  4. import { Listr } from '../index';
  5. import { PromptOptions } from '../utils/prompt.interface';
  6. export declare class TaskWrapper<Ctx, Renderer extends ListrRendererFactory> implements ListrTaskWrapper<Ctx, Renderer> {
  7. task: Task<Ctx, ListrRendererFactory>;
  8. errors: ListrError[];
  9. private options;
  10. constructor(task: Task<Ctx, ListrRendererFactory>, errors: ListrError[], options: ListrBaseClassOptions<Ctx, any, any>);
  11. set title(data: string);
  12. get title(): string;
  13. set output(data: string);
  14. get output(): string;
  15. set state(data: StateConstants);
  16. set message(data: ListrTaskObject<Ctx, Renderer>['message']);
  17. newListr(task: ListrTask<Ctx, Renderer> | ListrTask<Ctx, Renderer>[] | ((parent: this) => ListrTask<Ctx, Renderer> | ListrTask<Ctx, Renderer>[]), options?: ListrSubClassOptions<Ctx, Renderer>): Listr<Ctx, any, any>;
  18. report(error: Error | ListrError): void;
  19. skip(message: string): void;
  20. prompt<T = any>(options: PromptOptions | PromptOptions<true>[]): Promise<T>;
  21. stdout(): NodeJS.WriteStream & NodeJS.WritableStream;
  22. run(ctx: Ctx): Promise<void>;
  23. }