/goblins/entityapi/index.html Describe the auto-generated API for entities. Some call contains an contextual parts <> refering the destination property name. addTo addNewTo addCopyTo moveInto removeFrom set clear Hugo en-us /goblins/entityapi/addnewto/index.html Mon, 01 Jan 0001 00:00:00 +0000 /goblins/entityapi/addnewto/index.html Will create a new value and add it into the collection. This method is generally called by workitems when you add a new element in CRUD. This method is generated only for collection of values, ex: { type: 'project', values: { tasks: 'task[0..n]'; } } Example Add a new task entity into the tasks collection, using default values yield projectAPI.addNewToTasks(); Using a payload for initializing the new task const payload = { subject: 'Clean task', description: 'Clean codebase' }; yield projectAPI. /goblins/entityapi/apply/index.html Mon, 01 Jan 0001 00:00:00 +0000 /goblins/entityapi/apply/index.html Apply a new state to an entity. Example const patch = { score: 110, lvl: 10, powerUpStatus: 'enabled', }; yield entityAPI.apply({patch}); /goblins/entityapi/change/index.html Mon, 01 Jan 0001 00:00:00 +0000 /goblins/entityapi/change/index.html Change the state of an entity. The path arguments supports the Shredder set syntax Example yield entityAPI.change({path: 'score', newValue: 110}); /goblins/entityapi/clear/index.html Mon, 01 Jan 0001 00:00:00 +0000 /goblins/entityapi/clear/index.html Clear a collection Example Remove all tasks in collection. Important: if tasks is by value, all values will be hard deleted from storage. yield entityAPI.clearTasks(); /goblins/entityapi/get/index.html Mon, 01 Jan 0001 00:00:00 +0000 /goblins/entityapi/get/index.html Return the full entity state or a sub path. The path arguments supports the Shredder get syntax Example const entityState = yield entityAPI.get(); const name = yield entityAPI.get({path:'name'}); const metaStatus = yield entityAPI.get({path:'meta.status'}); /goblins/entityapi/set/index.html Mon, 01 Jan 0001 00:00:00 +0000 /goblins/entityapi/set/index.html Example Set customer relationship yield entityAPI.setCustomer({entityId: 'customer@some-uuid'});