just-login-session-state
An optional module that handles session state for just-login.
example
var Core = var SessionState = var Level = var tokenDb = var sessionDb = var core = var sessionState =
api
var SessionState =
var sessionState = SessionState(core, db, [options])
core
is an instance of a just-login-core.db
is expecting a levelup database.options
is an optional object:unauthenticateAfterMs
is a number in milliseconds of a session's period of inactivity before they are unauthenticated. (Callingauthenticate()
/isAuthenticated()
counts as activity.) Defaults to 1 week.deleteSessionAfterMs
is a number in milliseconds of a session's period of inactivity before the session is deleted. If the user does not callisAuthenticated()
within that time period, their session will be deleted. Defaults to 1 week.checkIntervalMs
is a number in milliseconds of the session's timeout's check interval. (See expireUnusedKeys({checkIntervalMs}).) Defaults to 10 seconds.
- Returns
sessionState
.
sessionState.createSession(cb)
Creates a new (unauthenticated) session.
cb
is a function that has the following arguments:err
isnull
or anError
object.sessionId
is a string of the new session id.
sessionState
sessionState.sessionExists(sessionId, cb)
sessionId
is a string of the session id for which to check the existence.cb
is a function that has the following arguments:err
isnull
or anError
object.date
isnull
if the session does not exist, otherwise it is adate
object.
sessionState
sessionState.deleteSession(sessionId, [cb])
sessionId
is a string of the session id to delete.cb
is an optional function that has the following argument:err
isnull
or anError
object.
sessionState
sessionState.isAuthenticated(sessionId, cb)
Checks if a user is authenticated. (Logged in.)
sessionId
is a string of the session id in question.cb
is a function with the following arguments:err
isnull
or anError
object.contactAddress
isnull
is the user is not authenticated, otherwise it is a string of their contact address.
sessionState
sessionState.unauthenticate(sessionId, [cb])
Sets the session id to be unauthenticated.
sessionId
is a string of the session id that is trying to get authenticated.cb
is an optional function with the following argument:err
isnull
or anError
object.
sessionState