mirror of https://github.com/Hax-io/libpb
- Added missing documentaion string for `authWithPassword()`
This commit is contained in:
parent
6b47078b89
commit
8483a60da8
|
@ -247,8 +247,19 @@ public class PocketBase
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
// TODO: Add comment
|
* Authenticates on the given auth table with the provided
|
||||||
|
* credentials, returning a JWT token in the reference parameter.
|
||||||
|
* Finally returning the record of the authenticated user.
|
||||||
|
*
|
||||||
|
* Params:
|
||||||
|
* table = the auth collection to use
|
||||||
|
* identity = the user's identity
|
||||||
|
* password = the user's password
|
||||||
|
* token = the variable to return into
|
||||||
|
*
|
||||||
|
* Returns: An instance of `RecordType`
|
||||||
|
*/
|
||||||
public RecordType authWithPassword(RecordType)(string table, string identity, string password, ref string token)
|
public RecordType authWithPassword(RecordType)(string table, string identity, string password, ref string token)
|
||||||
{
|
{
|
||||||
mixin isAuthable!(RecordType);
|
mixin isAuthable!(RecordType);
|
||||||
|
|
Loading…
Reference in New Issue