diff --git a/src/Options/Definitions.js b/src/Options/Definitions.js index 5b2e6e497a..132f5f8496 100644 --- a/src/Options/Definitions.js +++ b/src/Options/Definitions.js @@ -346,13 +346,13 @@ module.exports.ParseServerOptions = { }, liveQuery: { env: 'PARSE_SERVER_LIVE_QUERY', - help: "parse-server's LiveQuery configuration object", + help: "Configuration for LiveQuery on this Parse Server, for example `{ classNames: ['MyClass'] }`. `classNames` lists the classes that publish create/update/delete events to subscribers; without it no events are pushed, even while a LiveQuery server is running. Combine with `startLiveQueryServer` to run a LiveQuery server.", action: parsers.objectParser, type: 'LiveQueryOptions', }, liveQueryServerOptions: { env: 'PARSE_SERVER_LIVE_QUERY_SERVER_OPTIONS', - help: 'Live query server configuration options (will start the liveQuery server)', + help: 'Configuration options for the LiveQuery server. Providing this also starts the LiveQuery server (like `startLiveQueryServer`); events are still only published for the classes set in `liveQuery.classNames`.', action: parsers.objectParser, type: 'LiveQueryServerOptions', }, @@ -639,7 +639,7 @@ module.exports.ParseServerOptions = { }, startLiveQueryServer: { env: 'PARSE_SERVER_START_LIVE_QUERY_SERVER', - help: 'Starts the liveQuery server', + help: 'Starts a LiveQuery server alongside this Parse Server. Events are only delivered for the classes set in `liveQuery.classNames`, so a minimal working setup is `liveQuery: { classNames: [...] }` together with `startLiveQueryServer: true`.', action: parsers.booleanParser, }, trustProxy: { diff --git a/src/Options/docs.js b/src/Options/docs.js index 91d58cbe9b..564a9b1718 100644 --- a/src/Options/docs.js +++ b/src/Options/docs.js @@ -65,8 +65,8 @@ * @property {InstallationOptions} installation Options controlling how Parse Server deduplicates `_Installation` records that share the same `deviceToken`. * @property {String} javascriptKey Key for the Javascript SDK * @property {Boolean} jsonLogs Log as structured JSON objects - * @property {LiveQueryOptions} liveQuery parse-server's LiveQuery configuration object - * @property {LiveQueryServerOptions} liveQueryServerOptions Live query server configuration options (will start the liveQuery server) + * @property {LiveQueryOptions} liveQuery Configuration for LiveQuery on this Parse Server, for example `{ classNames: ['MyClass'] }`. `classNames` lists the classes that publish create/update/delete events to subscribers; without it no events are pushed, even while a LiveQuery server is running. Combine with `startLiveQueryServer` to run a LiveQuery server. + * @property {LiveQueryServerOptions} liveQueryServerOptions Configuration options for the LiveQuery server. Providing this also starts the LiveQuery server (like `startLiveQueryServer`); events are still only published for the classes set in `liveQuery.classNames`. * @property {Adapter} loggerAdapter Adapter module for the logging sub-system * @property {String} logLevel Sets the level for logs * @property {LogLevels} logLevels (Optional) Overrides the log levels used internally by Parse Server to log events. @@ -115,7 +115,7 @@ * @property {String} serverURL The URL to Parse Server.

⚠️ Certain server features or adapters may require Parse Server to be able to call itself by making requests to the URL set in `serverURL`. If a feature requires this, it is mentioned in the documentation. In that case ensure that the URL is accessible from the server itself. * @property {Number} sessionLength Session duration, in seconds, defaults to 1 year * @property {Boolean} silent Disables console output - * @property {Boolean} startLiveQueryServer Starts the liveQuery server + * @property {Boolean} startLiveQueryServer Starts a LiveQuery server alongside this Parse Server. Events are only delivered for the classes set in `liveQuery.classNames`, so a minimal working setup is `liveQuery: { classNames: [...] }` together with `startLiveQueryServer: true`. * @property {Any} trustProxy The trust proxy settings. It is important to understand the exact setup of the reverse proxy, since this setting will trust values provided in the Parse Server API request. See the express trust proxy settings documentation. Defaults to `false`. * @property {String[]} userSensitiveFields Personally identifiable information fields in the user table the should be removed for non-authorized users. Deprecated @see protectedFields * @property {Boolean} verbose Set the logging to verbose diff --git a/src/Options/index.js b/src/Options/index.js index d8f56defca..42f0ffb3b8 100644 --- a/src/Options/index.js +++ b/src/Options/index.js @@ -288,7 +288,7 @@ export interface ParseServerOptions { /* custom pages for password validation and reset :DEFAULT: {} */ customPages: ?CustomPagesOptions; - /* parse-server's LiveQuery configuration object */ + /* Configuration for LiveQuery on this Parse Server, for example `{ classNames: ['MyClass'] }`. `classNames` lists the classes that publish create/update/delete events to subscribers; without it no events are pushed, even while a LiveQuery server is running. Combine with `startLiveQueryServer` to run a LiveQuery server. */ liveQuery: ?LiveQueryOptions; /* Session duration, in seconds, defaults to 1 year :DEFAULT: 31536000 */ @@ -347,9 +347,9 @@ export interface ParseServerOptions { /* The trust proxy settings. It is important to understand the exact setup of the reverse proxy, since this setting will trust values provided in the Parse Server API request. See the express trust proxy settings documentation. Defaults to `false`. :DEFAULT: false */ trustProxy: ?any; - /* Starts the liveQuery server */ + /* Starts a LiveQuery server alongside this Parse Server. Events are only delivered for the classes set in `liveQuery.classNames`, so a minimal working setup is `liveQuery: { classNames: [...] }` together with `startLiveQueryServer: true`. */ startLiveQueryServer: ?boolean; - /* Live query server configuration options (will start the liveQuery server) */ + /* Configuration options for the LiveQuery server. Providing this also starts the LiveQuery server (like `startLiveQueryServer`); events are still only published for the classes set in `liveQuery.classNames`. */ liveQueryServerOptions: ?LiveQueryServerOptions; /* Options for request idempotency to deduplicate identical requests that may be caused by network issues. Caution, this is an experimental feature that may not be appropriate for production. :ENV: PARSE_SERVER_EXPERIMENTAL_IDEMPOTENCY_OPTIONS