@types/gulp-help

property dest

dest: gulp.DestMethod;

property src

src: gulp.SrcMethod;

property task

task: TaskMethod;

property watch

watch: gulp.WatchMethod;

property afterPrintCallback

afterPrintCallback?: Function | undefined;

• A function to run after the default help task runs

property aliases

aliases?: string[] | undefined;

• Adds aliases to the default help task

property description

description?: string | undefined;

• Modifies the default help message

property hideDepsMessage

hideDepsMessage?: boolean | undefined;

• Hide all task dependencies

property hideEmpty

hideEmpty?: boolean | undefined;

• Hide all tasks with no help message defined. Useful when including 3rd party tasks

property options

options?: { [key: string]: string } | undefined;

• Object documenting options which can be passed to your task

call signature

(
    name: string,
    help: HelpOption,
    deps: string[],
    fn?: gulp.TaskCallback,
    option?: TaskOptions
): any;

• Define a task.

  Parameter name

  the name of the task. Tasks that you want to run from the command line should not have spaces in them.

  Parameter help

  Custom help message as a string. If you want to hide the task from the help menu, supply false

  Parameter deps

  an array of tasks to be executed and completed before your task will run.

  Parameter fn

  the function that performs the task's operations. Generally this takes the form of gulp.src().pipe(someplugin()).

  Parameter option

  task options

call signature

(name: string, help: HelpOption, deps: string[]): any;

• Define a task.

  Parameter name

  the name of the task. Tasks that you want to run from the command line should not have spaces in them.

  Parameter help

  Custom help message as a string. If you want to hide the task from the help menu, supply false

  Parameter deps

  an array of tasks to be executed and completed before your task will run.

call signature

(
    name: string,
    help: HelpOption,
    fn?: gulp.TaskCallback,
    option?: TaskOptions
): any;

• Define a task.

  Parameter name

  the name of the task. Tasks that you want to run from the command line should not have spaces in them.

  Parameter help

  Custom help message as a string. If you want to hide the task from the help menu, supply false

  Parameter fn

  the function that performs the task's operations. Generally this takes the form of gulp.src().pipe(someplugin()).

  Parameter option

  task options

call signature

(name: string, help: HelpOption): any;

• Define a task.

  Parameter name

  the name of the task. Tasks that you want to run from the command line should not have spaces in them.

  Parameter help

  Custom help message as a string. If you want to hide the task from the help menu, supply false

call signature

(
    name: string,
    deps: string[],
    fn?: gulp.TaskCallback,
    option?: TaskOptions
): any;

• Define a task.

  Parameter name

  the name of the task. Tasks that you want to run from the command line should not have spaces in them.

  Parameter deps

  an array of tasks to be executed and completed before your task will run.

  Parameter fn

  the function that performs the task's operations. Generally this takes the form of gulp.src().pipe(someplugin()).

  Parameter option

  task options

call signature

(name: string, fn?: gulp.TaskCallback, option?: TaskOptions): any;

• Define a task.

  Parameter name

  the name of the task. Tasks that you want to run from the command line should not have spaces in them.

  Parameter fn

  the function that performs the task's operations. Generally this takes the form of gulp.src().pipe(someplugin()).

  Parameter option

  task options

property aliases

aliases?: string[] | undefined;

• List of aliases for this task

property options

options?: { [key: string]: string } | undefined;

• Object documenting options which can be passed to your task