SoulFire
Public TypeScript members of SoulFire.
Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.
Import this facade from @soulfiremc/sdk/bun or @soulfiremc/sdk/node for managed createBot, install, and installLayer. The universal and browser entry points connect to existing backends and do not expose these managed operations. Runtime entry points supply their HTTP layer; connectWithHttpClient and layerWithHttpClient require the application-provided effect/http/HttpClient service.
Compose Effect v4 operations with yield* inside a scoped workflow. Properties expose sub-clients and state.
connect
connect(options: SoulFireOptions): Effect<SoulFireClient, SoulFireConnectionError, Scope>layer
layer(options: SoulFireOptions): Layer<SoulFireService, SoulFireConnectionError, never>install
install(options?: SoulFireInstallOptions): Effect<SoulFireClient, SoulFireConnectionError, Scope>installLayer
installLayer(options?: SoulFireInstallOptions): Layer<SoulFireService, SoulFireConnectionError, never>createBot
createBot(options: ManagedBotOptions): Effect<SoulFireBot, SoulFireConnectionError | SoulFireOperationError, Scope>unauthenticated
unauthenticated(options: SoulFireOptions): Effect<SoulFireClient, SoulFireConnectionError, Scope>connectManaged
connectManaged(options: SoulFireOptions, localServer: LocalServerController): Effect<SoulFireClient, SoulFireConnectionError, Scope>connectWithHttpClient
connectWithHttpClient(options: SoulFireOptions): Effect<SoulFireClient, SoulFireConnectionError, Scope | HttpClient>layerWithHttpClient
layerWithHttpClient(options: SoulFireOptions): Layer<SoulFireService, SoulFireConnectionError, HttpClient>How is this page?
Last updated on