SoulFire TypeScript SDK 2.10.3
Guides
Python API
GitHub
Preparing search index...
index
SoulFireFleet
Class SoulFireFleet
Index
Constructors
constructor
Methods
distribute
restart
select
start
start
Tasks
stop
Constructors
constructor
new
SoulFireFleet
(
instance
:
SoulFireInstance
,
capabilities
?:
CapabilitySet
,
)
:
SoulFireFleet
Parameters
instance
:
SoulFireInstance
Optional
capabilities
:
CapabilitySet
Returns
SoulFireFleet
Methods
distribute
distribute
<
Item
>
(
items
:
readonly
Item
[]
,
selector
?:
FleetSelector
,
options
?:
FleetDistributionOptions
,
)
:
Effect
<
readonly
FleetAssignment
<
Item
>
[]
,
SoulFireOperationError
>
Type Parameters
Item
Parameters
items
:
readonly
Item
[]
selector
:
FleetSelector
= {}
options
:
FleetDistributionOptions
= {}
Returns
Effect
<
readonly
FleetAssignment
<
Item
>
[]
,
SoulFireOperationError
>
restart
restart
(
selector
?:
FleetSelector
,
options
?:
CallOptions
,
)
:
Effect
<
BotStatus
[]
,
SoulFireOperationError
>
Parameters
selector
:
FleetSelector
= {}
Optional
options
:
CallOptions
Returns
Effect
<
BotStatus
[]
,
SoulFireOperationError
>
select
select
(
selector
?:
FleetSelector
,
options
?:
CallOptions
,
)
:
Effect
<
readonly
FleetBot
[]
,
SoulFireOperationError
>
Parameters
selector
:
FleetSelector
= {}
Optional
options
:
CallOptions
Returns
Effect
<
readonly
FleetBot
[]
,
SoulFireOperationError
>
start
start
(
selector
?:
FleetSelector
,
options
?:
CallOptions
,
)
:
Effect
<
BotStatus
[]
,
SoulFireOperationError
>
Parameters
selector
:
FleetSelector
= {}
Optional
options
:
CallOptions
Returns
Effect
<
BotStatus
[]
,
SoulFireOperationError
>
start
Tasks
startTasks
<
Input
extends
DescMessage
,
Result
extends
DescMessage
|
undefined
=
undefined
,
>
(
selector
:
FleetSelector
,
inputSchema
:
Input
,
input
:
|
MessageInitShape
<
Input
>
|
(
(
bot
:
FleetBot
,
index
:
number
,
total
:
number
,
)
=>
|
MessageInitShape
<
Input
>
|
Effect
<
MessageInitShape
<
Input
>
,
SoulFireOperationError
,
never
>
)
,
resultSchema
?:
Result
,
options
?:
FleetTaskStartOptions
,
)
:
Effect
<
SoulFireFleetTaskGroup
<
Result
>
,
SoulFireOperationError
>
Type Parameters
Input
extends
DescMessage
Result
extends
DescMessage
|
undefined
=
undefined
Parameters
selector
:
FleetSelector
inputSchema
:
Input
input
:
|
MessageInitShape
<
Input
>
|
(
(
bot
:
FleetBot
,
index
:
number
,
total
:
number
,
)
=>
|
MessageInitShape
<
Input
>
|
Effect
<
MessageInitShape
<
Input
>
,
SoulFireOperationError
,
never
>
)
Optional
resultSchema
:
Result
options
:
FleetTaskStartOptions
= {}
Returns
Effect
<
SoulFireFleetTaskGroup
<
Result
>
,
SoulFireOperationError
>
stop
stop
(
selector
?:
FleetSelector
,
options
?:
CallOptions
,
)
:
Effect
<
BotStatus
[]
,
SoulFireOperationError
>
Parameters
selector
:
FleetSelector
= {}
Optional
options
:
CallOptions
Returns
Effect
<
BotStatus
[]
,
SoulFireOperationError
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
distribute
restart
select
start
start
Tasks
stop
Guides
Python API
GitHub
SoulFire TypeScript SDK 2.10.3
Loading...