# @types/gulp-help-doc

> TypeScript definitions for gulp-help-doc

Latest version **1.1.0** (published 2024-09-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/gulp-help-doc
pnpm add @types/gulp-help-doc
yarn add @types/gulp-help-doc
bun add @types/gulp-help-doc
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-09-27 |
| First published | 2016-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/gulp-help-doc
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-help-doc
- npm.io page: https://npm.io/package/@types/gulp-help-doc

## Dependencies (1)

- [@types/gulp](https://npm.io/package/@types/gulp.md) *

## Recent versions

- 1.1.0 (latest) — 2024-09-27
- 0.0.11 (ts4.5) — 2023-11-07
- 0.0.8 (ts3.7) — 2021-07-08
- 0.0.7 (ts3.0) — 2017-11-08
- 0.0.10 — 2023-10-18
- 0.0.9 — 2023-09-20
- 0.0.6 — 2017-03-15
- 0.0.5 — 2016-11-21
- 0.0.4 — 2016-09-19
- 0.0.3 — 2016-08-25
- 0.0.2 — 2016-08-19
- 0.0.1 — 2016-08-02

## README

# Installation
> `npm install --save @types/gulp-help-doc`

# Summary
This package contains type definitions for gulp-help-doc (https://github.com/Mikhus/gulp-help-doc).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-help-doc.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-help-doc/index.d.ts)
````ts
import gulp = require("gulp");

declare namespace usage {
    interface UsageOptions {
        /**
         * Defines max line width for the printed output lines.
         *
         * @default 80
         */
        lineWidth?: number | undefined;

        /**
         * Defines max width of the column width tasks or args names.
         *
         * @default 20
         */
        keysColumnWidth?: number | undefined;

        /**
         * Defines number of empty characters for left-padding of the output.
         * @default 4
         */
        padding?: number | undefined;

        /**
         * Defines number of empty characters before group name output.
         *
         * @default 1
         */
        groupPadding?: number | undefined;

        /**
         * Undocumented option.
         *
         * @default "magenta"
         */
        groupColor?: string | undefined;

        /**
         * Printing engine. Accepted any device which has log() function defined to do output.
         *
         * @default console
         */
        logger?: { log: (message: string) => void } | undefined;

        /**
         * Undocumented option.
         *
         * @default fs.existsSync('gulpfile.ts')
         */
        isTypescript?: boolean | undefined;

        /**
         * Path to a gulpfile.
         * Normally, there is no need to change this option. It may be used
         * for some special cases, like mocking gulpfile for testing.
         */
        gulpfile?: string | undefined;

        /**
         * if set to true, prints the task dependencies below its help description.
         *
         * @default true
         */
        displayDependencies?: boolean | undefined;

        /**
         * if set to true, prints an empty line between tasks help descriptions.
         *
         * @default true
         */
        emptyLineBetweenTasks?: boolean | undefined;

        /**
         * if group tag is not specified it will use specified group name.
         *
         * @default "Common tasks"
         */
        defaultGroupName?: string | undefined;
    }

    interface Usage {
        (gulp: gulp.Gulp, options?: UsageOptions): Promise<any>;
    }
}

declare const usage: usage.Usage;

export = usage;

````

### Additional Details
 * Last updated: Fri, 27 Sep 2024 17:07:38 GMT
 * Dependencies: [@types/gulp](https://npmjs.com/package/@types/gulp)

# Credits
These definitions were written by [Mikhus](https://github.com/Mikhus).

---
_Source: https://npm.io/package/@types/gulp-help-doc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._