- Added missing documentaion string for `authWithPassword()`

This commit is contained in:
Tristan B. Velloza Kildaire 2023-01-05 11:28:12 +02:00
parent 6b47078b89
commit 8483a60da8
1 changed files with 13 additions and 2 deletions

View File

@ -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)
{
mixin isAuthable!(RecordType);