CommanderJSX
Preparing search index...
dist
Command
Class Command<T>
Type Parameters
T
=
any
Implements
CommandMeta
<
T
>
Index
Constructors
constructor
Properties
children
description
executor?
name
options
parameters
parent?
version
Methods
add
Preset
check
Pattern
execute
get
Parent
Names
replace
Shortcut
show
Help
to
Children
String
to
Option
String
to
String
execute
name
Of
Constructors
constructor
new
Command
<
T
=
any
>
(
meta
:
CommandMeta
<
T
>
)
:
Command
<
T
>
Type Parameters
T
=
any
Parameters
meta
:
CommandMeta
<
T
>
Returns
Command
<
T
>
Properties
children
children
:
Command
<
T
>
[]
= []
description
description
:
string
= ''
Optional
executor
executor
?:
Executor
<
T
>
name
name
:
string
= ''
options
options
:
Options
<
T
>
= ...
parameters
parameters
:
string
= ''
Optional
parent
parent
?:
Command
<
T
>
version
version
:
string
= ''
Methods
Protected
add
Preset
addPreset
()
:
void
Returns
void
Protected
check
Pattern
checkPattern
(
options
:
OptionData
<
T
>
)
:
OptionData
<
T
>
Parameters
options
:
OptionData
<
T
>
Returns
OptionData
<
T
>
execute
execute
(
options
:
OptionData
<
T
>
,
...
data
:
Data
[]
)
:
void
Parameters
options
:
OptionData
<
T
>
...
data
:
Data
[]
Returns
void
get
Parent
Names
getParentNames
()
:
Generator
<
string
,
void
,
unknown
>
Returns
Generator
<
string
,
void
,
unknown
>
Protected
replace
Shortcut
replaceShortcut
(
options
:
OptionData
<
T
>
)
:
OptionData
<
T
>
Parameters
options
:
OptionData
<
T
>
Returns
OptionData
<
T
>
show
Help
showHelp
(
command
?:
string
)
:
void
Parameters
Optional
command
:
string
Returns
void
to
Children
String
toChildrenString
()
:
string
Returns
string
to
Option
String
toOptionString
()
:
string
Returns
string
to
String
toString
()
:
string
Returns a string representation of an object.
Returns
string
Static
execute
execute
<
T
>
(
command
:
Command
<
T
>
,
args
:
string
[]
)
:
void
Type Parameters
T
Parameters
command
:
Command
<
T
>
args
:
string
[]
Returns
void
Static
name
Of
nameOf
(
meta
:
Record
<
string
,
any
>
,
commandPath
:
string
)
:
string
|
undefined
Parameters
meta
:
Record
<
string
,
any
>
commandPath
:
string
Returns
string
|
undefined
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
children
description
executor
name
options
parameters
parent
version
Methods
add
Preset
check
Pattern
execute
get
Parent
Names
replace
Shortcut
show
Help
to
Children
String
to
Option
String
to
String
execute
name
Of
CommanderJSX
Loading...
Returns a string representation of an object.