From b185fad6957de32893ae1402f4fae982415537cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Smilek?= <41491201+lsmilek1@users.noreply.github.com> Date: Fri, 10 Sep 2021 15:49:20 +0200 Subject: [PATCH] Additional explication for `expireInactiveSessions` in ParseServerOptions (#7552) * Update docs.js Additional explication for `expireInactiveSessions` * Update index.js Additional explication for `expireInactiveSessions` * Update docs.js correcting spelling error * Update index.js correcting spelling error * Update Definitions.js Co-authored-by: Manuel <5673677+mtrezza@users.noreply.github.com> --- src/Options/Definitions.js | 3 ++- src/Options/docs.js | 2 +- src/Options/index.js | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/Options/Definitions.js b/src/Options/Definitions.js index 65799f81..53067a43 100644 --- a/src/Options/Definitions.js +++ b/src/Options/Definitions.js @@ -156,7 +156,8 @@ module.exports.ParseServerOptions = { }, expireInactiveSessions: { env: 'PARSE_SERVER_EXPIRE_INACTIVE_SESSIONS', - help: 'Sets wether we should expire the inactive sessions, defaults to true', + help: + 'Sets whether we should expire the inactive sessions, defaults to true. If false, all new sessions are created with no expiration date.', action: parsers.booleanParser, default: true, }, diff --git a/src/Options/docs.js b/src/Options/docs.js index 30b3aba1..c3dc43af 100644 --- a/src/Options/docs.js +++ b/src/Options/docs.js @@ -28,7 +28,7 @@ * @property {Boolean} enableAnonymousUsers Enable (or disable) anonymous users, defaults to true * @property {Boolean} enableExpressErrorHandler Enables the default express error handler for all errors * @property {String} encryptionKey Key for encrypting your files - * @property {Boolean} expireInactiveSessions Sets wether we should expire the inactive sessions, defaults to true + * @property {Boolean} expireInactiveSessions Sets whether we should expire the inactive sessions, defaults to true. If false, all new sessions are created with no expiration date. * @property {String} fileKey Key for your files * @property {Adapter} filesAdapter Adapter module for the files sub-system * @property {FileUploadOptions} fileUpload Options for file uploads diff --git a/src/Options/index.js b/src/Options/index.js index 5f3d9afa..552eb2e7 100644 --- a/src/Options/index.js +++ b/src/Options/index.js @@ -170,7 +170,7 @@ export interface ParseServerOptions { sessionLength: ?number; /* Max value for limit option on queries, defaults to unlimited */ maxLimit: ?number; - /* Sets wether we should expire the inactive sessions, defaults to true + /* Sets whether we should expire the inactive sessions, defaults to true. If false, all new sessions are created with no expiration date. :DEFAULT: true */ expireInactiveSessions: ?boolean; /* When a user changes their password, either through the reset password email or while logged in, all sessions are revoked if this is true. Set to false if you don't want to revoke sessions.