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

Help

Describes a series of tasks, their dependencies and arguments

Constructor Summary

Public Constructor
public

constructor(title: string, description: string)

Member Summary

Public Members
public get

Get a gulp task function.

Method Summary

Public Methods
public

registerArgument(argumentName: string, description: string, defaultValue: string)

Register an argument

public

registerTask(taskName: string, description: string, dependencies: Task[], args: Argument[])

Register a task

Public Constructors

public constructor(title: string, description: string) source

Params:

NameTypeAttributeDescription
title string
  • optional

The title of the project

description string
  • optional

A description for the project

Public Members

public get helpTask: function(): undefined: * source

Get a gulp task function. This should be passed to gulp.task.

Return:

function(): undefined

The gulp task function

Public Methods

public registerArgument(argumentName: string, description: string, defaultValue: string) source

Register an argument

Params:

NameTypeAttributeDescription
argumentName string

The name

description string

The description

defaultValue string
  • optional

The default value

public registerTask(taskName: string, description: string, dependencies: Task[], args: Argument[]) source

Register a task

Params:

NameTypeAttributeDescription
taskName string

The name

description string

The description

dependencies Task[]
  • optional
  • default: []

The dependant tasks

args Argument[]
  • optional
  • default: []

The arguments