@types/gulp-help

  • Version 0.0.35
  • Published
  • 7.51 kB
  • 3 dependencies
  • MIT license

Install

npm i @types/gulp-help
yarn add @types/gulp-help
pnpm add @types/gulp-help

Overview

TypeScript definitions for gulp-help

Index

Functions

function gulpHelp

gulpHelp: (gulp: any, options?: gulpHelp.GulpHelpOptions) => gulpHelp.GulpHelp;

    Interfaces

    interface GulpHelp

    interface GulpHelp extends Orchestrator {}

      property dest

      dest: gulp.DestMethod;

        property src

        src: gulp.SrcMethod;

          property task

          task: TaskMethod;

            property watch

            watch: gulp.WatchMethod;

              interface GulpHelpOptions

              interface GulpHelpOptions {}

                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

                interface TaskMethod

                interface TaskMethod {}

                  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

                  interface TaskOptions

                  interface TaskOptions {}

                    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

                    Package Files (1)

                    Dependencies (3)

                    Dev Dependencies (0)

                    No dev dependencies.

                    Peer Dependencies (0)

                    No peer dependencies.

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/gulp-help.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/gulp-help)
                    • HTML
                      <a href="https://www.jsdocs.io/package/@types/gulp-help"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>