📝 Document custom pages options (#5687)

This commit is contained in:
Yao Bin
2019-06-15 04:35:09 +08:00
committed by Diamond Lewis
parent 466a049bd0
commit 2a45ee02fb
3 changed files with 28 additions and 0 deletions

View File

@@ -356,6 +356,22 @@ module.exports.CustomPagesOptions = {
env: 'PARSE_SERVER_CUSTOM_PAGES_INVALID_LINK',
help: 'invalid link page path',
},
invalidVerificationLink: {
env: 'PARSE_SERVER_CUSTOM_PAGES_INVALID_VERIFICATION_LINK',
help: 'invalid verification link page path',
},
linkSendFail: {
env: 'PARSE_SERVER_CUSTOM_PAGES_LINK_SEND_FAIL',
help: 'verification link send fail page path',
},
linkSendSuccess: {
env: 'PARSE_SERVER_CUSTOM_PAGES_LINK_SEND_SUCCESS',
help: 'verification link send success page path',
},
parseFrameURL: {
env: 'PARSE_SERVER_CUSTOM_PAGES_PARSE_FRAME_URL',
help: 'for masking user-facing pages',
},
passwordResetSuccess: {
env: 'PARSE_SERVER_CUSTOM_PAGES_PASSWORD_RESET_SUCCESS',
help: 'password reset success page path',

View File

@@ -68,6 +68,10 @@
* @interface CustomPagesOptions
* @property {String} choosePassword choose password page path
* @property {String} invalidLink invalid link page path
* @property {String} invalidVerificationLink invalid verification link page path
* @property {String} linkSendFail verification link send fail page path
* @property {String} linkSendSuccess verification link send success page path
* @property {String} parseFrameURL for masking user-facing pages
* @property {String} passwordResetSuccess password reset success page path
* @property {String} verifyEmailSuccess verify email success page path
*/

View File

@@ -185,10 +185,18 @@ export interface CustomPagesOptions {
invalidLink: ?string;
/* verify email success page path */
verifyEmailSuccess: ?string;
/* invalid verification link page path */
invalidVerificationLink: ?string;
/* verification link send success page path */
linkSendSuccess: ?string;
/* verification link send fail page path */
linkSendFail: ?string;
/* choose password page path */
choosePassword: ?string;
/* password reset success page path */
passwordResetSuccess: ?string;
/* for masking user-facing pages */
parseFrameURL: ?string;
}
export interface LiveQueryOptions {