SoulFire LogoSoulFire

SoulFireFleet

Public TypeScript members of SoulFireFleet.

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.

select

select(
  selector: FleetSelector = {},
  options?: CallOptions,
): Effect.Effect<readonly FleetBot[], SoulFireOperationError>

Source

start

start(
  selector: FleetSelector = {},
  options?: CallOptions,
): Effect.Effect<BotStatus[], SoulFireOperationError>

Source

stop

stop(
  selector: FleetSelector = {},
  options?: CallOptions,
): Effect.Effect<BotStatus[], SoulFireOperationError>

Source

restart

restart(
  selector: FleetSelector = {},
  options?: CallOptions,
): Effect.Effect<BotStatus[], SoulFireOperationError>

Source

startTasks

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.Effect<MessageInitShape<Input>, SoulFireOperationError>),
  resultSchema?: Result,
  options: FleetTaskStartOptions = {},
): Effect.Effect<SoulFireFleetTaskGroup<Result>, SoulFireOperationError>

Source

distribute

distribute<Item>(
  items: readonly Item[],
  selector: FleetSelector = {},
  options: FleetDistributionOptions = {},
): Effect.Effect<readonly FleetAssignment<Item>[], SoulFireOperationError>

Source

How is this page?

Last updated on

On this page