Module: @proceed/capabilities

Classes

ConfigurationError
NotFoundError

Methods

(static) capabilityListUpdate()

A registered callback for registerForNewOrRemovedCapabilities which check if an item is included or removed to the capability list of the engine, if an item is tried to be added during runtime, a message is raised.

Source:

(static) checkDoubleOccurences(capabilityList)

A Function that checks for multiple occurences of the same capability item

Parameters:
Name Type Description
capabilityList list

throw a configuration error and stops the engine in case there are multiple occurences
Source:

(static) isCapabilityExecutable(processDescription, capabilityDescription)

A Function that receives a processDescription and a capability desciption of an engine and checks whether the process description can be executed in the engine with the given capability description

Parameters:
Name Type Description
processDescription list
capabilityDescription list
Source:
Returns:

boolean

(static) isCapabilityLocallyExecutable(processDescription)

A Function that receives a processDescription and checks whether the process is executable locally

Parameters:
Name Type Description
processDescription list
Source:
Returns:

boolean

(static) start()

An async function that starts the capability module, gets the capability list of the engine, checks for double occurences and calls the endpoint in order to see all the capabilities of the engine

Source:

(static) startCapability(capabilityName, args) → {object}

A Function that receives an capabilityName, arguments for the native function and a callback

Parameters:
Name Type Description
capabilityName string

the URI of the capability name or only the action name
args object

the arguments needed for native function, parameter names are given as described in the semantic description
Source:
Returns:

the return item of the native function in the parsed form as described in the semantic description if there is there a callback from the native function then the function returns null

Type
object