Options
All
  • Public
  • Public/Protected
  • All
Menu

An input slot is Slot with a callback function that gets called when a new message arrive through the associated connection.

It also features a description of the triggered process and a contract for message validation.

Hierarchy

Index

Constructors

constructor

  • new InputSlot(slotId: string, moduleId: string, metadata: { contract: IExpectation<unknown>; description: string }, subscribeFct: (__namedParameters: Object) => void): InputSlot
  • Parameters

    • slotId: string

      slot id within the module

    • moduleId: string

      module id

    • metadata: { contract: IExpectation<unknown>; description: string }
    • subscribeFct: (__namedParameters: Object) => void

      callback function, connection is the associated connection, data is the incoming message

        • (__namedParameters: Object): void
        • Parameters

          • __namedParameters: Object

          Returns void

    Returns InputSlot

Properties

Readonly contract

contract: IExpectation<unknown>

Contract of the input slot regarding incoming data

Readonly description

description: string

Description of the purpose of the callback function

Readonly metadata

metadata: any

Readonly moduleId

moduleId: string

Readonly slotId

slotId: string

Readonly subscribeFct

subscribeFct: (__namedParameters: Object) => void

Type declaration

    • (__namedParameters: Object): void
    • Parameters

      • __namedParameters: Object

      Returns void

Generated using TypeDoc