Skip to content

Commit 2a45ee0

Browse files
alvinthendplewis
authored andcommitted
📝 Document custom pages options (#5687)
1 parent 466a049 commit 2a45ee0

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

src/Options/Definitions.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,22 @@ module.exports.CustomPagesOptions = {
356356
env: 'PARSE_SERVER_CUSTOM_PAGES_INVALID_LINK',
357357
help: 'invalid link page path',
358358
},
359+
invalidVerificationLink: {
360+
env: 'PARSE_SERVER_CUSTOM_PAGES_INVALID_VERIFICATION_LINK',
361+
help: 'invalid verification link page path',
362+
},
363+
linkSendFail: {
364+
env: 'PARSE_SERVER_CUSTOM_PAGES_LINK_SEND_FAIL',
365+
help: 'verification link send fail page path',
366+
},
367+
linkSendSuccess: {
368+
env: 'PARSE_SERVER_CUSTOM_PAGES_LINK_SEND_SUCCESS',
369+
help: 'verification link send success page path',
370+
},
371+
parseFrameURL: {
372+
env: 'PARSE_SERVER_CUSTOM_PAGES_PARSE_FRAME_URL',
373+
help: 'for masking user-facing pages',
374+
},
359375
passwordResetSuccess: {
360376
env: 'PARSE_SERVER_CUSTOM_PAGES_PASSWORD_RESET_SUCCESS',
361377
help: 'password reset success page path',

src/Options/docs.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@
6868
* @interface CustomPagesOptions
6969
* @property {String} choosePassword choose password page path
7070
* @property {String} invalidLink invalid link page path
71+
* @property {String} invalidVerificationLink invalid verification link page path
72+
* @property {String} linkSendFail verification link send fail page path
73+
* @property {String} linkSendSuccess verification link send success page path
74+
* @property {String} parseFrameURL for masking user-facing pages
7175
* @property {String} passwordResetSuccess password reset success page path
7276
* @property {String} verifyEmailSuccess verify email success page path
7377
*/

src/Options/index.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,10 +185,18 @@ export interface CustomPagesOptions {
185185
invalidLink: ?string;
186186
/* verify email success page path */
187187
verifyEmailSuccess: ?string;
188+
/* invalid verification link page path */
189+
invalidVerificationLink: ?string;
190+
/* verification link send success page path */
191+
linkSendSuccess: ?string;
192+
/* verification link send fail page path */
193+
linkSendFail: ?string;
188194
/* choose password page path */
189195
choosePassword: ?string;
190196
/* password reset success page path */
191197
passwordResetSuccess: ?string;
198+
/* for masking user-facing pages */
199+
parseFrameURL: ?string;
192200
}
193201

194202
export interface LiveQueryOptions {

0 commit comments

Comments
 (0)