Skip to content

Commit 3cc27b0

Browse files
committed
Update Global Configuration options
1 parent 587779f commit 3cc27b0

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/api-overview.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,11 +257,20 @@ The following default options are available for configuration:
257257

258258
```js
259259
const defaultOptions = {
260+
autoRemove: false, // Automatically remove records missing from responses (only use with feathers-rest)
261+
addOnUpsert: false, // Add new records pushed by 'updated/patched' socketio events into store, instead of discarding them
262+
enableEvents: true, // Listens to socket.io events when available
260263
idField: 'id', // The field in each record that will contain the id
261-
autoRemove: false, // automatically remove records missing from responses (only use with feathers-rest)
262-
nameStyle: 'short', // Determines the source of the module name. 'short' or 'path'
263-
enableEvents: true, // Set to false to explicitly disable socket event handlers.
264-
preferUpdate: false, // When true, calling modelInstance.save() will do an update instead of a patch.
264+
tempIdField: '__id',
265+
debug: false, // Set to true to enable logging messages.
266+
keepCopiesInStore: false, // Set to true to store cloned copies in the store instead of on the Model.
267+
nameStyle: 'short', // Determines the source of the module name. 'short', 'path', or 'explicit'
268+
paramsForServer: [], // Custom query operators that are ignored in the find getter, but will pass through to the server.
269+
preferUpdate: false, // When true, calling model.save() will do an update instead of a patch.
270+
replaceItems: false, // Instad of merging in changes in the store, replace the entire record.
271+
serverAlias: 'api',
272+
skipRequestIfExists: false, // For get action, if the record already exists in store, skip the remote request
273+
whitelist: [] // Custom query operators that will be allowed in the find getter.
265274
}
266275
```
267276

0 commit comments

Comments
 (0)