Skip to content

Commit 7dcf0d0

Browse files
committed
Update docs
1 parent 733a543 commit 7dcf0d0

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

lib/pow/store/credentials_cache.ex

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@ defmodule Pow.Store.CredentialsCache do
22
@moduledoc """
33
Default module for credentials session storage.
44
5-
A key (session id), is used to store, fetch or delete credentials. When
6-
credentials are stored or deleted, a credentials key will be generated.
7-
The value of that key will be all current keys (session ids), and the
8-
most recent credentials.
9-
10-
When a key is updated, all expired keys will be pruned from the credentials
11-
key.
12-
13-
The credentials are expected to take the form of
5+
A key (session id) is used to store, fetch, or delete credentials. The
6+
credentials are expected to take the form of
147
`{credentials, session_metadata}`, where session metadata is data exclusive
158
to the session id.
9+
10+
This module also adds two utility methods:
11+
12+
* `users/2` - to list all current users
13+
* `sessions/2` - to list all current sessions
1614
"""
1715
alias Pow.{Config, Store.Base}
1816

0 commit comments

Comments
 (0)