Skip to content

Commit df12ba3

Browse files
authored
docs: regenerate API docs (#8179)
1 parent a5ba5da commit df12ba3

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

src/Options/Definitions.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@ module.exports.ParseServerOptions = {
140140
},
141141
databaseAdapter: {
142142
env: 'PARSE_SERVER_DATABASE_ADAPTER',
143-
help: 'Adapter module for the database',
143+
help:
144+
'Adapter module for the database; any options that are not explicitly described here are passed directly to the database client.',
144145
action: parsers.moduleOrObjectParser,
145146
},
146147
databaseOptions: {

src/Options/docs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* @property {Number|Boolean} cluster Run with cluster, optionally set the number of processes default to os.cpus().length
2929
* @property {String} collectionPrefix A collection prefix for the classes
3030
* @property {CustomPagesOptions} customPages custom pages for password validation and reset
31-
* @property {Adapter<StorageAdapter>} databaseAdapter Adapter module for the database
31+
* @property {Adapter<StorageAdapter>} databaseAdapter Adapter module for the database; any options that are not explicitly described here are passed directly to the database client.
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.
3434
* @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`.

0 commit comments

Comments
 (0)