Skip to content
mercury framework
GitHub

ChannelLogins

ChannelLogins = object

Defined in: types/channel-types/index.ts:372

Logins of people to the services Mercury’s plugins act on, for a channel that can receive the provider’s redirect (the HTTP surface, when it has a public URL). accept offers the URL the provider sends the person back to; without one, a plugin asking for a login says no channel can take it. complete finishes the login the state was issued for, with the code the provider sent: state is single-use and tied to the person who started, so the request carrying it needs no other credential.

accept: (callbackUrl) => void

Defined in: types/channel-types/index.ts:373

string

void


complete: (state, code) => Promise<LoginOutcome>

Defined in: types/channel-types/index.ts:374

string

string

Promise<LoginOutcome>