Auth
constAuth:object
Type Declaration
Section titled “Type Declaration”connect
Section titled “connect”connect: (
server) =>Effect<ConnectResult,never,never>
Matches the server name exactly, ignoring case.
Parameters
Section titled “Parameters”server
Section titled “server”string
Returns
Section titled “Returns”Effect<ConnectResult, never, never>
getServer
Section titled “getServer”getServer: () =>
Effect<string|null,never,never>
Returns
Section titled “Returns”Effect<string | null, never, never>
getServers
Section titled “getServers”getServers: () =>
Effect<readonlyServer[],never,never>
Returns
Section titled “Returns”Effect<readonly Server[], never, never>
getUsername
Section titled “getUsername”getUsername: () =>
Effect<string|null,never,never>
Returns
Section titled “Returns”Effect<string | null, never, never>
isLoggedIn
Section titled “isLoggedIn”isLoggedIn: () =>
Effect<boolean,never,never>
Returns
Section titled “Returns”Effect<boolean, never, never>
login: () =>
Effect<boolean,never,never>
Logs this account back in, after waiting out a temporary kick.
Returns
Section titled “Returns”Effect<boolean, never, never>
logout
Section titled “logout”logout: () =>
Effect<void,never,never>
Returns
Section titled “Returns”Effect<void, never, never>