Options
All
  • Public
  • Public/Protected
  • All
Menu

Module InternalOptions

Index

Namespaces

Enumerations

Enumeration members

Classes

Interfaces

Type aliases

Enumeration members

DATA

DATA = "DATA"

MESSAGE

MESSAGE = "MESSAGE"

Type aliases

CrossSpawnArgs

CrossSpawnArgs: ReadonlyArray<string> | undefined

List of string arguments.

CrossSpawnOptions

CrossSpawnOptions: SpawnOptions & { logger?: LoggerFunction; updateErrorCallback?: any }

ForgeListrTask

ForgeListrTask<T>: TaskWrapper<T, ListrDefaultRenderer>

Type parameters

  • T

ListrBaseClassOptions

ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>: ListrOptions<Ctx> & ListrDefaultRendererOptions<Renderer> & ListrDefaultNonTTYRendererOptions<FallbackRenderer>

Parent class options.

Parent class has more options where you can also select the and set renderer and non-tty renderer.

Any subtasks will respect those options so they will be stripped of that properties.

Type parameters

ListrContext

ListrContext: any | undefined

Listr Default Context

ListrDefaultRenderer

ListrDefaultRenderer: typeof DefaultRenderer

Type of default renderer

ListrDefaultRendererValue

ListrDefaultRendererValue: "default"

The default renderer value used in Listr2 applications

ListrEvent

ListrEvent: { data?: string | boolean; type: Exclude<ListrEventType, "MESSAGE" | "DATA"> } | { data: string; type: DATA } | { data: Task<any, any>["message"]; type: MESSAGE }

The internal communication event.

ListrFallbackRenderer

ListrFallbackRenderer: typeof VerboseRenderer

Type of default fallback renderer

ListrFallbackRendererValue

ListrFallbackRendererValue: "verbose"

Name of default fallback renderer

ListrGetRendererClassFromValue

ListrGetRendererClassFromValue<T>: T extends ListrDefaultRendererValue ? ListrDefaultRenderer : T extends ListrSimpleRendererValue ? ListrSimpleRenderer : T extends ListrFallbackRendererValue ? ListrFallbackRenderer : T extends ListrSilentRenderer ? ListrSilentRenderer : T extends ListrRendererFactory ? T : never

Returns the class type from friendly names of the renderers.

Type parameters

ListrGetRendererOptions

ListrGetRendererOptions<T>: T extends ListrDefaultRendererValue ? ListrDefaultRenderer["rendererOptions"] : T extends ListrSimpleRendererValue ? ListrSimpleRenderer["rendererOptions"] : T extends ListrFallbackRendererValue ? ListrFallbackRenderer["rendererOptions"] : T extends ListrSilentRenderer ? ListrSilentRenderer["rendererOptions"] : T extends ListrRendererFactory ? T["rendererOptions"] : never

Returns renderer global options depending on the renderer type.

Type parameters

ListrGetRendererTaskOptions

ListrGetRendererTaskOptions<T>: T extends ListrDefaultRendererValue ? ListrDefaultRenderer["rendererTaskOptions"] : T extends ListrSimpleRendererValue ? ListrSimpleRenderer : T extends ListrFallbackRendererValue ? ListrFallbackRenderer["rendererTaskOptions"] : T extends ListrSilentRenderer ? ListrSilentRenderer["rendererTaskOptions"] : T extends ListrRendererFactory ? T["rendererTaskOptions"] : never

Returns renderer per task options depending on the renderer type.

Type parameters

ListrRendererFactory

ListrRendererFactory: typeof ListrRenderer

A renderer factory from the current type

ListrRendererValue

ListrRendererValue: ListrSilentRendererValue | ListrDefaultRendererValue | ListrSimpleRendererValue | ListrFallbackRendererValue | ListrRendererFactory

Listr2 can process either the integrated renderers as string aliases, or utilize a compatible style renderer that extends the ListrRenderer abstract class.

ListrSilentRenderer

ListrSilentRenderer: typeof SilentRenderer

Typeof silent renderer

ListrSilentRendererValue

ListrSilentRendererValue: "silent"

Silent rendere for internal usage

ListrSimpleRenderer

ListrSimpleRenderer: typeof SimpleRenderer

Typeof simple renderer

ListrSimpleRendererValue

ListrSimpleRendererValue: "simple"

Simple renderer that simplifies things

ListrSubClassOptions

ListrSubClassOptions<Ctx, Renderer>: ListrOptions<Ctx> & Omit<ListrDefaultRendererOptions<Renderer>, "renderer">

Sub class options.

Subtasks has reduced set options where the missing ones are explicitly set by the base class.

Type parameters

ListrTaskResult

ListrTaskResult<Ctx>: string | Promise<any> | Listr<Ctx, ListrRendererValue, any> | Readable | NodeJS.ReadableStream | Observable<any>

Task can be set of sync or async function, an Observable or a stream.

Type parameters

  • Ctx

LoggerFunction

LoggerFunction: (message: string) => void

Type declaration

    • (message: string): void

    • Parameters

      • message: string

      Returns void

ModuleType

ModuleType: "prod" | "dev" | "optional"

PackageJSONWithDeps

PackageJSONWithDeps: { dependencies?: Record<string, string>; devDependencies?: Record<string, string> }

Type declaration

  • Optional dependencies?: Record<string, string>
  • Optional devDependencies?: Record<string, string>

PromptOptions

PromptOptions<T>: Unionize<{ [ K in PromptTypes]-?: T extends true ? { type: K } & PromptOptionsType<K> & { name: string | (() => string) } : { type: K } & PromptOptionsType<K> }> | (({ type: string } & T) extends true ? PromptOptionsType<string> & { name: string | (() => string) } : PromptOptionsType<string>)

Returns all the prompt options depending on the type selected.

Type parameters

  • T: boolean = false

PromptOptions

PromptOptions: BasePromptOptions | ArrayPromptOptions | BooleanPromptOptions | StringPromptOptions | NumberPromptOptions | SnippetPromptOptions | SortPromptOptions

PromptOptionsType

PromptOptionsType<T>: T extends keyof PromptOptionsMap ? PromptOptionsMap[T] : T extends string ? BasePromptOptions & Record<PropertyKey, unknown> : any

Type parameters

  • T

PromptTypes

PromptTypes: "AutoComplete" | "BasicAuth" | "Confirm" | "Editable" | "Form" | "Input" | "Invisible" | "List" | "MultiSelect" | "Numeral" | "Password" | "Quiz" | "Scale" | "Select" | "Snippet" | "Sort" | "Survey" | "Text" | "Toggle"

RebuildMode

RebuildMode: "sequential" | "parallel"

TeardownLogic

TeardownLogic: Subscription | Unsubscribable | (() => void) | void

Unionize

Unionize<T>: { [ P in keyof T]: T[P] }[keyof T]

Type parameters

  • T: Record<PropertyKey, unknown>