Home Reference Source Repository

Function

Static Public Summary
public

alias(id: string, aliases: ...string)

Registers alias(es) for a task
public

check(src: string[], dest: string[], options: Object): boolean

Checks sources vs destinations last modification times
public

cli()

Process tasks execution and command line options
public

do(id: string, params: Object, force: boolean): *

Executes task
public

Checks task status, is it done?
public

error(from: string, mesg: ...string)

Logs error messages
public

force(id: *, params: {}): *

Shortcut for forced task execution, see do
public

is(id: string, batch: function)

Defines task
public

log(from: string, mesg: ...string)

Logs messages from task
public

msg(mesg: ...string)

Logs anonymous messages
public

Registers task as done
public

Clears done status for a task
public

warn(from: string, mesg: ...string)

Logs warning messages

Static Public

public alias(id: string, aliases: ...string) source

Registers alias(es) for a task

Params:

NameTypeAttributeDescription
id string

Task name
aliases ...string

Task alias(es)

Example:

 task.alias('default', 'build', 'main');

public check(src: string[], dest: string[], options: Object): boolean source

Checks sources vs destinations last modification times

Params:

NameTypeAttributeDescription
src string[]

Sources globs to check. Can be single string
dest string[]

Resulting build files to check. Can be single string
options Object
  • optional

Options for glob.sync() when matching sources

Return:

boolean

true if rebuild is needed, false if all files are up to date

Example:

 if (!task.check('src/*.js', 'build/static/main.js') return;

public cli() source

Process tasks execution and command line options

public do(id: string, params: Object, force: boolean): * source

Executes task

Params:

NameTypeAttributeDescription
id string

Task name
params Object
  • optional

Task params
force boolean
  • optional

Force execution, no registering, no checks

Return:

*

public done(id: string): boolean source

Checks task status, is it done?

Params:

NameTypeAttributeDescription
id string

Task name

Return:

boolean

true if done, false if undone

public error(from: string, mesg: ...string) source

Logs error messages

Params:

NameTypeAttributeDescription
from string

Task badge
mesg ...string

Error messages

public force(id: *, params: {}): * source

Shortcut for forced task execution, see do

Params:

NameTypeAttributeDescription
id *
params {}
  • optional
  • default: {}

Return:

*

public is(id: string, batch: function) source

Defines task

Params:

NameTypeAttributeDescription
id string

Task name
batch function

function associated with a task. If it's string - works like alias too

public log(from: string, mesg: ...string) source

Logs messages from task

Params:

NameTypeAttributeDescription
from string

Task badge
mesg ...string

Messages

Example:

 task.log('build', 'Build started');

public msg(mesg: ...string) source

Logs anonymous messages

Params:

NameTypeAttributeDescription
mesg ...string

Messages

Example:

 task.msg('Message', 'from', 'nowhere');

public reg(id: string): boolean source

Registers task as done

Params:

NameTypeAttributeDescription
id string

Task name

Return:

boolean

true if success, false if task is already done

public undo(id: string): boolean source

Clears done status for a task

Params:

NameTypeAttributeDescription
id string

Task name

Return:

boolean

true if success, false if task is not done yet

public warn(from: string, mesg: ...string) source

Logs warning messages

Params:

NameTypeAttributeDescription
from string

Task badge
mesg ...string

Warnings