Home Reference Source Test
import Task from 'gulp-task-help/src/Task.js'
public class | source

Task

A task description

Static Method Summary

Static Public Methods
public static

compare(taskA: Task, taskB: Task): number} @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare | String.prototype.localeCompare

Compare two tasks lexicographically by name

Constructor Summary

Public Constructor
public

constructor(taskName: string, description: string=)

Member Summary

Public Members
public get
public get
public get
public get
public get
public get

name: string: *

Method Summary

Public Methods
public

Add an argument to the task

public

Add a task dependency to the task

Static Public Methods

public static compare(taskA: Task, taskB: Task): number} @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare | String.prototype.localeCompare source

Compare two tasks lexicographically by name

Params:

NameTypeAttributeDescription
taskA Task

The first task

taskB Task

The second task

Return:

number} @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare | String.prototype.localeCompare

Public Constructors

public constructor(taskName: string, description: string=) source

Params:

NameTypeAttributeDescription
taskName string

The task name

description string=

The task description

Public Members

public get arguments: Argument[]: * source

Return:

Argument[]

A sorted list of task arguments

public get argumentsNames: string[]: * source

Return:

string[]

A sorted list of task argument names

public get dependencies: Task[]: * source

Return:

Task[]

A sorted list of task dependencies

public get dependenciesNames: string[]: * source

Return:

string[]

A sorted list of task dependency names

public get description: string: * source

Return:

string

The task description

public get name: string: * source

Return:

string

The task name

Public Methods

public addArgument(arg: Argument) source

Add an argument to the task

Params:

NameTypeAttributeDescription
arg Argument

The argument to add

public addDependency(dep: Task) source

Add a task dependency to the task

Params:

NameTypeAttributeDescription
dep Task

The dependency to add