Skip to content

Commit 6a13cb2

Browse files
committed
improved resetTokenValidityDuration docs
1 parent 52e531e commit 6a13cb2

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

src/Options/Definitions.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -746,18 +746,26 @@ module.exports.PasswordPolicyOptions = {
746746
resetTokenReuseIfValid: {
747747
env: 'PARSE_SERVER_PASSWORD_POLICY_RESET_TOKEN_REUSE_IF_VALID',
748748
help:
749+
<<<<<<< HEAD
749750
<<<<<<< HEAD
750751
'Set to `true` if a password reset token should be reused in case another token is requested but there is a token that is still valid, i.e. has not expired. This avoids the often observed issue that a user requests multiple emails and does not know which link contains a valid token because each newly generated token would invalidate the previous token.<br><br>Default is `false`.',
751752
=======
752753
'Reuse password reset token if it has not expired; requires `resetTokenValidityDuration` to be set. Default is `false`.',
753754
>>>>>>> improved resetTokenReuseIfValid docs
755+
=======
756+
'Is true if the password reset token should be reused if it has not expired; requires `resetTokenValidityDuration` to be set. Default is `false`.',
757+
>>>>>>> improved resetTokenValidityDuration docs
754758
action: parsers.booleanParser,
755759
default: false,
756760
},
757761
resetTokenValidityDuration: {
758762
env: 'PARSE_SERVER_PASSWORD_POLICY_RESET_TOKEN_VALIDITY_DURATION',
759763
help:
764+
<<<<<<< HEAD
760765
'Set the validity duration of the password reset token in seconds after which the token expires. The token is used in the link that is set in the email. After the token expires, the link becomes invalid and a new link has to be sent. If the option is not set or set to `undefined`, then the token never expires.<br><br>For example, to expire the token after 2 hours, set a value of 7200 seconds (= 60 seconds * 60 minutes * 2 hours).<br><br>Default is `undefined`.',
766+
=======
767+
'The time duration in seconds after which a password reset token expires and becomes invalid. Default is indefinite (never expires).',
768+
>>>>>>> improved resetTokenValidityDuration docs
761769
action: parsers.numberParser('resetTokenValidityDuration'),
762770
},
763771
validationError: {

src/Options/docs.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@
186186
* @property {Boolean} doNotAllowUsername disallow username in passwords
187187
* @property {Number} maxPasswordAge days for password expiry
188188
* @property {Number} maxPasswordHistory setting to prevent reuse of previous n passwords
189-
* @property {Boolean} resetTokenReuseIfValid Reuse password reset token if it has not expired; requires `resetTokenValidityDuration` to be set. Default is `false`.
190-
* @property {Number} resetTokenValidityDuration time for token to expire
189+
* @property {Boolean} resetTokenReuseIfValid Is true if the password reset token should be reused if it has not expired; requires `resetTokenValidityDuration` to be set. Default is `false`.
190+
* @property {Number} resetTokenValidityDuration The time duration in seconds after which a password reset token expires and becomes invalid. Default is indefinite (never expires).
191191
* @property {Function} validatorCallback a callback function to be invoked to validate the password
192192
* @property {String} validatorPattern a RegExp object or a regex string representing the pattern to enforce
193193
>>>>>>> improved resetTokenReuseIfValid docs

0 commit comments

Comments
 (0)