Five On It

Appearance

five-on-it / apps/api/src/steam-routes / SteamSignIn

Interface: SteamSignIn ​

Defined in: apps/api/src/steam-routes.ts:54

Signing in through Steam's OpenID from another page of the API's (the OAuth sign-in page).

Methods ​

exchange() ​

exchange(code, level?): Promise<SteamOutcome>

Defined in: apps/api/src/steam-routes.ts:61

Exchanges the code a sign-in came back with (once): the session, or why not; level is what the account must be able to do (creator for the OAuth page: a lent copy is refused).

Parameters ​

code ​

string

level? ​

"player" | "creator"

Returns ​

Promise<SteamOutcome>

startUrl() ​

startUrl(returnTo): string

Defined in: apps/api/src/steam-routes.ts:56

The address that starts a sign-in through Steam, back at returnTo (one of the platform's own).

Parameters ​

returnTo ​

string

Returns ​

string