Add some docs for the lifetime of Signup

This commit is contained in:
David Baker 2016-10-11 11:58:10 +01:00
parent 30319d8e44
commit b62fb50619

View file

@ -51,6 +51,9 @@ class Signup {
/** /**
* Registration logic class * Registration logic class
* This exists for the lifetime of a user's attempt to register an account,
* so if their registration attempt fails for whatever reason and they
* try again, call register() on the same instance again.
*/ */
class Register extends Signup { class Register extends Signup {
constructor(hsUrl, isUrl, opts) { constructor(hsUrl, isUrl, opts) {
@ -117,6 +120,9 @@ class Register extends Signup {
}); });
} }
/**
* Starts the registration process from the first stage
*/
register(formVals) { register(formVals) {
var {username, password, email} = formVals; var {username, password, email} = formVals;
this.email = email; this.email = email;