SoulFireClient
Public TypeScript members of SoulFireClient.
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.
connect
Connects and checks the server is compatible: its SDK API version,
requiredCapabilities and requiredPlugins.
static connect(
options: SoulFireOptions,
): Effect.Effect<SoulFireClient, SoulFireConnectionError, Scope.Scope>unauthenticated
A client that skips that check, for example to log in first.
static unauthenticated(
options: SoulFireOptions,
): Effect.Effect<SoulFireClient, SoulFireConnectionError, Scope.Scope>connectManaged
static connectManaged(
options: SoulFireOptions,
localServer: LocalServerController,
): Effect.Effect<SoulFireClient, SoulFireConnectionError, Scope.Scope>setToken
setToken(token: string | TokenProvider | undefined): voidlocalServer
get localServer(): LocalSoulFireServer | undefinedserver
get server(): ServerMetadataidentity
get identity(): Readonly<SdkIdentity>capabilities
get capabilities(): CapabilitySetlimits
get limits(): ReadonlyMap<string, bigint>plugins
get plugins(): PluginCatalogadmin
get admin(): SoulFireAdminlocalServerLogs
get localServerLogs(): readonly string[]isLocalServerRunning
get isLocalServerRunning(): booleanrestartLocalServer
restartLocalServer(): Effect.Effect<void, SoulFireOperationError>stopLocalServer
stopLocalServer(): Effect.Effect<void, SoulFireOperationError>service
service<T extends DescService>(service: T): Client<T>instance
A handle for instanceId, without a request.
instance(instanceId: string): SoulFireInstanceinstances
instances(
options?: CallOptions,
): Effect.Effect<InstanceListResponse_Instance[], SoulFireOperationError>createInstance
createInstance(
friendlyName: string,
options?: CallOptions,
): Effect.Effect<SoulFireInstance, SoulFireOperationError>beginLogin
beginLogin(
email: string,
options?: CallOptions,
): Effect.Effect<NextAuthFlowResponse, SoulFireOperationError>completeLogin
completeLogin(
authFlowToken: string,
code: string,
options?: CallOptions,
): Effect.Effect<NextAuthFlowResponse, SoulFireOperationError>close
close(): Effect.Effect<void>How is this page?
Last updated on