SDK API Reference
- getInstance(basePath)
-
-
basePath <string> Optional. The path to the operator descriptor (operator.json) directory. Default set to the directory where the operator's script file is located.
- Returns: <Operator>
-
- config
-
-
Returns: <object>
-
- addShutdownHandler(handler)
-
-
handler <Function> The handler to be called before terminating this operator
- Returns: <void>
-
- done()
-
-
Returns: <void>
-
- fail(message)
-
-
message <string> Error message to be written out
- Returns: <void>
-
- getInPort(name)
-
-
name <string> The name of the input port
- Returns: <InPort>
-
- getOutPort(name)
-
-
name <string> The name of the output port
- Returns: <OutPort>
-
- getInPorts()
-
-
Returns: <Map<string, InPort>>
-
- getOutPorts()
-
-
Returns: <Map<string, OutPort>>
-
- logger
-
-
Returns: <Logger>
-
