HelpHandler | /command/mod.ts | cliffy@v1.0.0-rc.1

Module

x/cliffy/command/mod.ts>HelpHandler

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...

c4spar/deno-cliffy

Extremely Popular

Go to Latest

assets completions help test types upgrade

mod.ts (default module)

Type

ActionListType

BashCompletionsCommand

FishCompletionsCommand

ZshCompletionsCommand

DenoLandProviderOptions

EnvVar

EnvVarOptions

Example

GithubProviderOptions

GithubVersions

GlobalEnvVarOptions

GlobalOptionOptions

NestLandProviderOptions

UpgradeCommandOptions

UpgradeOptions

ValidationErrorOptions

CompleteHandlerResult

dim

red

CompleteHandlerResult

type alias HelpHandler

Re-export

import { type HelpHandler } from "https://deno.land/x/cliffy@v1.0.0-rc.1/command/mod.ts";

Help callback method to print the help. Invoked by the --help option and help command and the .getHelp() and .showHelp() methods.

Type Parameters

optional

TOptions extends Record<string, any> | void = any

optional

TArguments extends Array<unknown> = TOptions extends number ? any : []

optional

TGlobals extends Record<string, any> | void = TOptions extends number ? any : void

optional

TParentGlobals extends Record<string, any> | void = TOptions extends number ? any : void

optional

TTypes extends Record<string, any> | void = TOptions extends number ? any : void

optional

TGlobalTypes extends Record<string, any> | void = TOptions extends number ? any : void

optional

TParentTypes extends Record<string, any> | void = TOptions extends number ? any : void

optional

TParentCommand extends Command<any> | undefined = TOptions extends number ? any : undefined

optional

TCommand extends Command<TParentGlobals, TParentTypes, TOptions, TArguments, TGlobals, TTypes, TGlobalTypes, TParentCommand> = Command<TParentGlobals, TParentTypes, TOptions, TArguments, TGlobals, TTypes, TGlobalTypes, TParentCommand>

definition: (

this: TCommand,

cmd: TCommand,

options: HelpOptions,

) => string