Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Task<O>

Type parameters

  • O = any

Hierarchy

Indexable

[k: string]: any

Index

Properties

Optional async

async: boolean | number

Dependences are executed serially by default. If order doesn't matter and you want better performance via parallel, you can mark it as asynchronized. Asynchronized will run immediately whether there are synchronized tasks before them or not. You can pass a number as the priority of asynchronized tasks, bigger is formmer.

Optional dependencies

dependencies: TaskDep[]

Optional desc

desc: undefined | string

Optional fn

fn: undefined | ((ctx: TaskContext<O>) => void | Promise<void>)

Optional force

force: undefined | false | true

Whether rerun it when it occured in dependences tree more then once.

Optional loading

loading: undefined | false | true
description

whether show loading

default

globalOptions.loading

Optional logCommand

logCommand: undefined | false | true
description

whether log executed command

default

globalOptions.logCommand

Optional logger

logger: ILoggerProps

name

name: string

namespaces

namespaces: string[]

options

options: O

rawArgs

rawArgs: string[]

Raw arg strings

Optional resolveOptions

resolveOptions: undefined | ((ctx: TaskContext) => Promise<O> | O)

Optional strict

strict: undefined | false | true
description

Whether task options only allow defined options, default false

default

false

Generated using TypeDoc