Skip to content

Commit 1d5290e

Browse files
committed
Improving the description of defaultLimit config option
1 parent ffc23a4 commit 1d5290e

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/Options/Definitions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ module.exports.ParseServerOptions = {
156156
},
157157
defaultLimit: {
158158
env: 'PARSE_SERVER_DEFAULT_LIMIT',
159-
help: 'Default limit for the size of results set on queries, defaults to 100',
159+
help: 'Default limit for the size of results set on queries, defaults to `100`.',
160160
action: parsers.numberParser('defaultLimit'),
161161
},
162162
directAccess: {

src/Options/docs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* @property {Adapter<StorageAdapter>} databaseAdapter Adapter module for the database
3232
* @property {DatabaseOptions} databaseOptions Options to pass to the database client
3333
* @property {String} databaseURI The full URI to your database. Supported databases are mongodb or postgres.
34-
* @property {Number} defaultLimit Default limit for the size of results set on queries, defaults to 100
34+
* @property {Number} defaultLimit Default limit for the size of results set on queries, defaults to `100`.
3535
* @property {Boolean} directAccess Set to `true` if Parse requests within the same Node.js environment as Parse Server should be routed to Parse Server directly instead of via the HTTP interface. Default is `false`.<br><br>If set to `false` then Parse requests within the same Node.js environment as Parse Server are executed as HTTP requests sent to Parse Server via the `serverURL`. For example, a `Parse.Query` in Cloud Code is calling Parse Server via a HTTP request. The server is essentially making a HTTP request to itself, unnecessarily using network resources such as network ports.<br><br>⚠️ In environments where multiple Parse Server instances run behind a load balancer and Parse requests within the current Node.js environment should be routed via the load balancer and distributed as HTTP requests among all instances via the `serverURL`, this should be set to `false`.
3636
* @property {String} dotNetKey Key for Unity and .Net SDK
3737
* @property {Adapter<MailAdapter>} emailAdapter Adapter module for email sending

src/Options/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ export interface ParseServerOptions {
194194
/* Session duration, in seconds, defaults to 1 year
195195
:DEFAULT: 31536000 */
196196
sessionLength: ?number;
197-
/* Default limit for the size of results set on queries, defaults to 100 */
197+
/* Default limit for the size of results set on queries, defaults to `100`. */
198198
defaultLimit: ?number;
199199
/* Max value for limit option on queries, defaults to unlimited */
200200
maxLimit: ?number;

0 commit comments

Comments
 (0)