Command | /command/command.ts | cliffy@v1.0.0-rc.2

Module

x/cliffy/command/command.ts>Command#versionOption

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

method Command.prototype.versionOption

import { Command } from "https://deno.land/x/cliffy@v1.0.0-rc.2/command/command.ts";

versionOption(enable: false): this

Disable version option.

versionOption(

flags: string,

desc?: string,

opts?: OptionOptions<Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand> & { global: true; },

): this

Set global version option.

versionOption(

flags: string,

desc?: string,

opts?: OptionOptions<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>,

): this

Set version option.

versionOption(

flags: string,

desc?: string,

opts?: ActionHandler<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>,

): this

Set version option.

Disable version option.

Parameters

enable: false

Returns

this

Set global version option.

Parameters

flags: string

The flags of the version option.

optional

desc: string

The description of the version option.

optional

opts: OptionOptions<Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand> & { global: true; }

Version option options.

Returns

this

Set version option.

Parameters

flags: string

The flags of the version option.

optional

desc: string

The description of the version option.

optional

opts: OptionOptions<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>

Version option options.

Returns

this

Set version option.

Parameters

flags: string

The flags of the version option.

optional

desc: string

The description of the version option.

optional

opts: ActionHandler<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>

The action of the version option.

Returns

this