Skip to content

Commit b62fb50

Browse files
committed
Add some docs for the lifetime of Signup
1 parent 30319d8 commit b62fb50

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/Signup.js

+6
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ class Signup {
5151

5252
/**
5353
* Registration logic class
54+
* This exists for the lifetime of a user's attempt to register an account,
55+
* so if their registration attempt fails for whatever reason and they
56+
* try again, call register() on the same instance again.
5457
*/
5558
class Register extends Signup {
5659
constructor(hsUrl, isUrl, opts) {
@@ -117,6 +120,9 @@ class Register extends Signup {
117120
});
118121
}
119122

123+
/**
124+
* Starts the registration process from the first stage
125+
*/
120126
register(formVals) {
121127
var {username, password, email} = formVals;
122128
this.email = email;

0 commit comments

Comments
 (0)