Class: Clerc<Commands, GlobalFlags>
Defined in: packages/core/src/cli.ts:45
Type Parameters
Commands
Commands extends CommandsRecord = { }
GlobalFlags
GlobalFlags extends ClercFlagsDefinition = { }
Accessors
_commands
Get Signature
get _commands(): CommandsMap;Defined in: packages/core/src/cli.ts:99
Returns
_description
Get Signature
get _description(): string;Defined in: packages/core/src/cli.ts:91
Returns
string
_globalFlags
Get Signature
get _globalFlags(): GlobalFlags;Defined in: packages/core/src/cli.ts:103
Returns
GlobalFlags
_name
Get Signature
get _name(): string;Defined in: packages/core/src/cli.ts:83
Returns
string
_scriptName
Get Signature
get _scriptName(): string;Defined in: packages/core/src/cli.ts:87
Returns
string
_version
Get Signature
get _version(): string;Defined in: packages/core/src/cli.ts:95
Returns
string
Methods
command()
Call Signature
command<Name, Parameters, Flags>(command): Clerc<Commands & Record<string, CommandWithHandler<Name, Parameters, Flags>>, GlobalFlags>;Defined in: packages/core/src/cli.ts:189
Type Parameters
Name
Name extends string
Parameters
Parameters extends readonly string[] = readonly []
Flags
Flags extends ClercFlagsDefinition = { }
Parameters
command
CommandWithHandler<Name, Parameters, Flags>
Returns
Clerc<Commands & Record<string, CommandWithHandler<Name, Parameters, Flags>>, GlobalFlags>
Call Signature
command<Name, Parameters, Flags>(
name,
description,
options?): Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>;Defined in: packages/core/src/cli.ts:199
Type Parameters
Name
Name extends string
Parameters
Parameters extends readonly string[] = readonly []
Flags
Flags extends ClercFlagsDefinition = { }
Parameters
name
Name extends keyof Commands ? ["COMMAND ALREADY EXISTS"] : Name
description
string
options?
CommandOptions<Parameters, Flags>
Returns
Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>
description()
description(description): this;Defined in: packages/core/src/cli.ts:123
Parameters
description
string
Returns
this
errorHandler()
errorHandler(handler): this;Defined in: packages/core/src/cli.ts:141
Parameters
handler
ErrorHandler
Returns
this
globalFlag()
globalFlag<Name, Flag>(
name,
description,
options): Clerc<Commands, GlobalFlags & Record<Name, Flag>>;Defined in: packages/core/src/cli.ts:246
Type Parameters
Name
Name extends string
Flag
Flag extends ClercGlobalFlagDefinitionValue
Parameters
name
Name
description
string
options
Flag
Returns
Clerc<Commands, GlobalFlags & Record<Name, Flag>>
interceptor()
interceptor(interceptor): this;Defined in: packages/core/src/cli.ts:262
Parameters
interceptor
Interceptor<Command<string, readonly string[], ClercFlagsDefinition>, GlobalFlags>
Returns
this
name()
name(name): this;Defined in: packages/core/src/cli.ts:111
Parameters
name
string
Returns
this
on()
on<Name>(name, handler): this;Defined in: packages/core/src/cli.ts:268
Type Parameters
Name
Name extends string | number | symbol | string & Record<never, never>
Parameters
name
Name
handler
CommandHandler<Commands[Name], GlobalFlags>
Returns
this
parse()
parse<Run>(argvOrOptions): Run extends true ? Promise<void> : Clerc<Commands, GlobalFlags>;Defined in: packages/core/src/cli.ts:373
Type Parameters
Run
Run extends boolean = true
Parameters
argvOrOptions
string[] | ParseOptions<Run>
Returns
Run extends true ? Promise<void> : Clerc<Commands, GlobalFlags>
run()
run(): Promise<void>;Defined in: packages/core/src/cli.ts:305
Returns
Promise<void>
scriptName()
scriptName(scriptName): this;Defined in: packages/core/src/cli.ts:117
Parameters
scriptName
string
Returns
this
use()
use(plugin): this;Defined in: packages/core/src/cli.ts:135
Parameters
plugin
Returns
this
version()
version(version): this;Defined in: packages/core/src/cli.ts:129
Parameters
version
string
Returns
this
create()
static create(options?): Clerc;Defined in: packages/core/src/cli.ts:107
Parameters
options?
Returns
Clerc