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>
This commit is contained in:
Lukáš Smilek
2021-09-10 15:49:20 +02:00
committed by GitHub
parent 429b959964
commit b185fad695
3 changed files with 4 additions and 3 deletions

View File

@@ -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,
},

View File

@@ -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>} filesAdapter Adapter module for the files sub-system
* @property {FileUploadOptions} fileUpload Options for file uploads

View File

@@ -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.