Skip to content
Lucent
Esc
↑↓navigate↵open
On this page

api.auth

Members

api.auth.connectTo()

api.auth.connectTo(server: string): Effect.Effect<ConnectOutcome>
Name Type Required Default Description
server string

Returns: ConnectOutcome

Errors: never

api.auth.getPassword()

api.auth.getPassword(): Effect.Effect<string>

Returns: string

Errors: never

api.auth.getServers()

api.auth.getServers(): Effect.Effect<readonly LiveServer[]>

Returns: readonly LiveServer[]

Errors: never

api.auth.getUsername()

api.auth.getUsername(): Effect.Effect<string>

Returns: string

Errors: never

api.auth.isLoggedIn()

api.auth.isLoggedIn(): Effect.Effect<boolean>

Returns: boolean

Errors: never

api.auth.isServerSelectReady()

api.auth.isServerSelectReady(): Effect.Effect<boolean>

Returns: boolean

Errors: never

api.auth.isTemporarilyKicked()

api.auth.isTemporarilyKicked(): Effect.Effect<boolean>

Returns: boolean

Errors: never

api.auth.login()

api.auth.login(username: string, password: string): Effect.Effect<boolean>
Name Type Required Default Description
username string
password string

Returns: boolean

Errors: never

api.auth.logout()

api.auth.logout(): Effect.Effect<void>

Returns: void

Errors: never

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?