Updated function documentation specification.
parent
3b9693e276
commit
df09a192b0
|
@ -74,12 +74,14 @@ Authenticate a user and return a new cookie for the new session.
|
||||||
Spec:
|
Spec:
|
||||||
|
|
||||||
```
|
```
|
||||||
-spec authenticate(User, Password, Cookies, Bucket) -> {true, Cookie} | false | {error, Reason} when
|
-spec authenticate(User, Password, Cookies, Bucket) -> {true, Cookie, Validity} |
|
||||||
|
false | {error, Reason} when
|
||||||
User :: binary(),
|
User :: binary(),
|
||||||
Password :: binary(),
|
Password :: binary(),
|
||||||
Cookies :: atom(),
|
Cookies :: atom(),
|
||||||
Bucket :: atom(),
|
Bucket :: atom(),
|
||||||
Cookie :: binary(),
|
Cookie :: binary(),
|
||||||
|
Validity :: non_neg_integer(),
|
||||||
Reason :: term().
|
Reason :: term().
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue