Function: logIn()

function logIn(
   browser, 
   siteUrl, 
   __namedParameters?
): Promise<LoginResult>;

Defined in: core/login.ts:77

Makes sure there's a session: the user at once if there is one; otherwise a browser window at the site's login page, waiting (calling onWait) until the person logs in there themselves. The session is saved (ADR-003), and the window closes again unless the browser is shown on demand. It waits timeoutMs, 5 minutes by default.

Parameters

Parameter	Type
browser	BrowserManager
siteUrl	string
__namedParameters	{ onWait?: (elapsedMs) => void; timeoutMs?: number; }
__namedParameters.onWait?	(elapsedMs) => void
__namedParameters.timeoutMs?	number

Returns

Promise<LoginResult>