SoulFire LogoSoulFire

BotSession

Public TypeScript members of BotSession.

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.

open

static open(
  stream: BotEventStreamFactory,
  options: BotSessionOptions = {},
): Effect.Effect<BotSession, SoulFireOperationError, Scope.Scope>

Source

state

get state(): BotSessionState

Source

events

Subscribes lazily; slow readers lose the oldest buffered events.

events(): Stream.Stream<BotEvent, SoulFireOperationError>

Source

waitFor

waitFor(
  predicate: (event: BotEvent, state: BotSessionState) => boolean,
  options: { readonly timeoutMs?: number } = {},
): Effect.Effect<BotEvent, SoulFireOperationError>

Source

once

once(
  eventCase: BotEvent["event"]["case"],
  options?: { readonly timeoutMs?: number },
): Effect.Effect<BotEvent, SoulFireOperationError>

Source

close

close(): Effect.Effect<void>

Source

How is this page?

Last updated on

On this page