Skip to content

Commit d769fb3

Browse files
committed
improve docs
1 parent 812c824 commit d769fb3

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ The client keys used with Parse are no longer necessary with Parse Server. If yo
245245
* `auth` - Used to configure support for [3rd party authentication](http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication).
246246
* `facebookAppIds` - An array of valid Facebook application IDs that users may authenticate with.
247247
* `mountPath` - Mount path for the server. Defaults to `/parse`.
248-
* `directAccess` - Replace HTTP Interface when using JS SDK in current node runtime. Defaults to false.
248+
* `directAccess` - Replace HTTP Interface when using JS SDK in current node runtime. Defaults to false. Caution, this is an experimental feature that may not be appropriate for production.
249249
* `filesAdapter` - The default behavior (GridStore) can be changed by creating an adapter class (see [`FilesAdapter.js`](https://github.com/parse-community/parse-server/blob/master/src/Adapters/Files/FilesAdapter.js)).
250250
* `maxUploadSize` - Max file size for uploads. Defaults to 20 MB.
251251
* `loggerAdapter` - The default behavior/transport (File) can be changed by creating an adapter class (see [`LoggerAdapter.js`](https://github.com/parse-community/parse-server/blob/master/src/Adapters/Logger/LoggerAdapter.js)).

src/Options/Definitions.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ module.exports.ParseServerOptions = {
157157
help:
158158
'Protected fields that should be treated with extra security when fetching details.',
159159
action: parsers.objectParser,
160-
default: { _User: { '*': ['email'] } },
160+
default: [],
161161
},
162162
enableAnonymousUsers: {
163163
env: 'PARSE_SERVER_ENABLE_ANON_USERS',
@@ -282,7 +282,8 @@ module.exports.ParseServerOptions = {
282282
},
283283
directAccess: {
284284
env: 'PARSE_SERVER_ENABLE_EXPERIMENTAL_DIRECT_ACCESS',
285-
help: 'Replace HTTP Interface when using JS SDK in current node runtime',
285+
help:
286+
'Replace HTTP Interface when using JS SDK in current node runtime, defaults to false. Caution, this is an experimental feature that may not be appropriate for production.',
286287
action: parsers.booleanParser,
287288
default: false,
288289
},

src/Options/docs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
* @property {Number} schemaCacheTTL The TTL for caching the schema for optimizing read/write operations. You should put a long TTL when your DB is in production. default to 5000; set 0 to disable.
5252
* @property {Number} cacheTTL Sets the TTL for the in memory cache (in ms), defaults to 5000 (5 seconds)
5353
* @property {Number} cacheMaxSize Sets the maximum size for the in memory cache, defaults to 10000
54-
* @property {Boolean} directAccess Replace HTTP Interface when using JS SDK in current node runtime
54+
* @property {Boolean} directAccess Replace HTTP Interface when using JS SDK in current node runtime, defaults to false. Caution, this is an experimental feature that may not be appropriate for production.
5555
* @property {Boolean} enableSingleSchemaCache Use a single schema cache shared across requests. Reduces number of queries made to _SCHEMA, defaults to false, i.e. unique schema cache per request.
5656
* @property {Boolean} enableExpressErrorHandler Enables the default express error handler for all errors
5757
* @property {Number} objectIdSize Sets the number of characters in generated object id's, default 10

src/Options/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ export interface ParseServerOptions {
145145
/* Sets the maximum size for the in memory cache, defaults to 10000
146146
:DEFAULT: 10000 */
147147
cacheMaxSize: ?number;
148-
/* Replace HTTP Interface when using JS SDK in current node runtime
148+
/* Replace HTTP Interface when using JS SDK in current node runtime, defaults to false. Caution, this is an experimental feature that may not be appropriate for production.
149149
:ENV: PARSE_SERVER_ENABLE_EXPERIMENTAL_DIRECT_ACCESS
150150
:DEFAULT: false */
151151
directAccess: ?boolean;

0 commit comments

Comments
 (0)