Module: instance-updater

Methods

(async, static) updateInstance(options) → {Promise.<Array.<ObjectCreation>>}

Parameters:
Name Type Description
options InstanceUpdaterOptions

Use this module through instance.registerRecipes for your convenience. It provides the name and owner from the active instance and registers any given Recipes with the currently running instance, which this function does not do since you could create or update an inactive instance. Note that recipes are not added to the runtime, since you might be updating an inactive Instance object.

Source:
Returns:

Returns the result of creating the Instance object and, if provided Recipe and Module objects. The Instance object creation result always is in the first position and always exists. The Person object creation result is in second place, but it only exists if the Person object had to be created. Recipe and Module creation results only exist if any recipes or modules were provided.

Type: Promise.<Array.<ObjectCreation>>