Search
Preparing search index...
The search index is not available
@algo-builder/algob
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@algo-builder/algob
types
TaskDefinition
Interface TaskDefinition
Hierarchy
ConfigurableTaskDefinition
TaskDefinition
Index
Properties
action
description
is
Internal
name
param
Definitions
positional
Param
Definitions
Methods
add
Flag
add
Optional
Param
add
Optional
Positional
Param
add
Optional
Variadic
Positional
Param
add
Param
add
Positional
Param
add
Variadic
Positional
Param
set
Action
set
Description
Properties
Readonly
action
action
:
ActionType
<
any
>
Optional
Readonly
description
description
?:
string
Readonly
is
Internal
is
Internal
:
boolean
Readonly
name
name
:
string
Readonly
param
Definitions
param
Definitions
:
ParamDefinitionsMap
Readonly
positional
Param
Definitions
positional
Param
Definitions
:
ParamDefinitionAny
[]
Methods
add
Flag
add
Flag
(
name
:
string
, description
?:
string
)
:
this
Parameters
name:
string
Optional
description:
string
Returns
this
add
Optional
Param
add
Optional
Param
<
T
>
(
name
:
string
, description
?:
string
, defaultValue
?:
T
, type
?:
ArgumentType
<
T
>
)
:
this
Type parameters
T
Parameters
name:
string
Optional
description:
string
Optional
defaultValue:
T
Optional
type:
ArgumentType
<
T
>
Returns
this
add
Optional
Positional
Param
add
Optional
Positional
Param
<
T
>
(
name
:
string
, description
?:
string
, defaultValue
?:
T
, type
?:
ArgumentType
<
T
>
)
:
this
Type parameters
T
Parameters
name:
string
Optional
description:
string
Optional
defaultValue:
T
Optional
type:
ArgumentType
<
T
>
Returns
this
add
Optional
Variadic
Positional
Param
add
Optional
Variadic
Positional
Param
<
T
>
(
name
:
string
, description
?:
string
, defaultValue
?:
T
[]
, type
?:
ArgumentType
<
T
>
)
:
this
Type parameters
T
Parameters
name:
string
Optional
description:
string
Optional
defaultValue:
T
[]
Optional
type:
ArgumentType
<
T
>
Returns
this
add
Param
add
Param
<
T
>
(
name
:
string
, description
?:
string
, defaultValue
?:
T
, type
?:
ArgumentType
<
T
>
, isOptional
?:
boolean
)
:
this
Type parameters
T
Parameters
name:
string
Optional
description:
string
Optional
defaultValue:
T
Optional
type:
ArgumentType
<
T
>
Optional
isOptional:
boolean
Returns
this
add
Positional
Param
add
Positional
Param
<
T
>
(
name
:
string
, description
?:
string
, defaultValue
?:
T
, type
?:
ArgumentType
<
T
>
, isOptional
?:
boolean
)
:
this
Type parameters
T
Parameters
name:
string
Optional
description:
string
Optional
defaultValue:
T
Optional
type:
ArgumentType
<
T
>
Optional
isOptional:
boolean
Returns
this
add
Variadic
Positional
Param
add
Variadic
Positional
Param
<
T
>
(
name
:
string
, description
?:
string
, defaultValue
?:
T
[]
, type
?:
ArgumentType
<
T
>
, isOptional
?:
boolean
)
:
this
Type parameters
T
Parameters
name:
string
Optional
description:
string
Optional
defaultValue:
T
[]
Optional
type:
ArgumentType
<
T
>
Optional
isOptional:
boolean
Returns
this
set
Action
set
Action
(
action
:
ActionType
<
any
>
)
:
this
Parameters
action:
ActionType
<
any
>
Returns
this
set
Description
set
Description
(
description
:
string
)
:
this
Parameters
description:
string
Returns
this
Exports
convert
runtime
types
Task
Definition
action
description
is
Internal
name
param
Definitions
positional
Param
Definitions
add
Flag
add
Optional
Param
add
Optional
Positional
Param
add
Optional
Variadic
Positional
Param
add
Param
add
Positional
Param
add
Variadic
Positional
Param
set
Action
set
Description
Generated using
TypeDoc