Namespace

Configuration

Configuration

The default configuration is provided here. This is overridden by passing a 'conf' object to module:jsonapi-vuex.jsonapiModule

Properties:
Name Type Default Description
jvtag string '_jv'

key to store jsonapi-vuex-related data in when destructuring (default: '_jv')

followRelationshipsData boolean true

Follow relationships 'data' entries (from store)

preserveJSON boolean false

Preserve API response json in return data

mergeRecords boolean false

Merge or overwrite store records

clearOnUpdate boolean false

Delete old records not contained in an update (on a per-type basis).

cleanPatch boolean false

Always run 'cleanPatch' method when patching

cleanPatchProps Array.<string> '[]'

If cleanPatch is enabled, which _jv props (links, meta, rels) should be kept?

recurseRelationships boolean false

Allow relationships to be recursive?

maxStatusID integer -1

The maximum number of status IDs to generate before looping. Default is unlimited.

View Source config.js, line 1