Class SoulFireFleetTaskGroup<Result>

constructor

• new SoulFireFleetTaskGroup<Result extends DescMessage | undefined = undefined>(
      members: readonly FleetTaskMember<Result>[],
      startFailures: readonly FleetTaskStartFailure[],
  ): SoulFireFleetTaskGroup<Result>

  Type Parameters

  • Result extends DescMessage | undefined = undefined

  Parameters

  • members: readonly FleetTaskMember<Result>[]
  • startFailures: readonly FleetTaskStartFailure[]

  Returns SoulFireFleetTaskGroup<Result>

ReadonlystartFailures

botIds

• get botIds(): readonly string[]

  Returns readonly string[]

size

• get size(): number

  Returns number

taskIds

• get taskIds(): readonly string[]

  Returns readonly string[]

cancel

• cancel(
      reason?: string,
      options?: { call?: CallOptions; concurrency?: number },
  ): Effect<FleetTaskReport<undefined>, SoulFireOperationError>

  Parameters

  • reason: string = ""
  • Optionaloptions: { call?: CallOptions; concurrency?: number }

  Returns Effect<FleetTaskReport<undefined>, SoulFireOperationError>

events

• events(
      options?: { afterRevision?: bigint; call?: CallOptions },
  ): Stream<FleetTaskEvent, SoulFireOperationError>

  Parameters

  • Optionaloptions: { afterRevision?: bigint; call?: CallOptions }

  Returns Stream<FleetTaskEvent, SoulFireOperationError>

requireResults

• requireResults(
      options?: { call?: CallOptions },
  ): Effect<
      readonly {
          bot: FleetBot;
          status: "fulfilled";
          value: FleetTaskResultValue<Result>;
      }[],
      FleetTaskGroupError<Result>,
  >

  Parameters

  • Optionaloptions: { call?: CallOptions }

  Returns Effect<
      readonly {
          bot: FleetBot;
          status: "fulfilled";
          value: FleetTaskResultValue<Result>;
      }[],
      FleetTaskGroupError<Result>,
  >

results

• results(options?: { call?: CallOptions }): Effect<FleetTaskReport<Result>>

  Parameters

  • Optionaloptions: { call?: CallOptions }

  Returns Effect<FleetTaskReport<Result>>

task

• task(botId: string): SoulFireTask<Result> | undefined

  Parameters

  • botId: string

  Returns SoulFireTask<Result> | undefined