Class NopeBaseModule

constructor

• new NopeBaseModule(_core): NopeBaseModule

• Creates an instance of BaseModule.

  Memberof

  BaseModule

  Parameters

  • _core: INopeCore

  Returns NopeBaseModule

_markedElements

author

description

identifier

uiLinks

version

events

• get events(): {
      [index: string]: IEventOptions;
  }

• Public get to receive a Description of the Properties

  Memberof

  BaseModule

  Returns {
      [index: string]: IEventOptions;
  }

  • [index: string]: IEventOptions

methods

• get methods(): {
      [index: string]: IServiceOptions;
  }

• Public getter for the functions

  Memberof

  BaseModule

  Returns {
      [index: string]: IServiceOptions;
  }

  • [index: string]: IServiceOptions

properties

• get properties(): {
      [index: string]: IEventOptions;
  }

• Public get to receive a Description of the Properties

  Memberof

  BaseModule

  Returns {
      [index: string]: IEventOptions;
  }

  • [index: string]: IEventOptions

type

• get type(): string

• Return the Class Identifier.

  Returns string

dispose

• dispose(): Promise<void>

• Function, which is used to unregister the element.

  Memberof

  NopeBaseModule

  Returns Promise<void>

getIdentifierOf

• getIdentifierOf(prop_event_or_func, type?): string

• Helper Function to extract the used identifiert of Property

  Returns

  {string}

  Memberof

  NopeBaseModule

  Parameters

  • prop_event_or_func: INopeObservable<any, any, any, IEventAdditionalData> | ((...args) => Promise<any>)

    The Property or the Function to receive the Name.

  • type: "topicToPublish" | "topicToSubscribe" = null

  Returns string

init

• init(...args): Promise<void>

• An init Function. Used to initialize the Element.

  Returns

  Memberof

  NopeBaseModule

  Parameters

  • Rest ...args: any[]

  Returns Promise<void>

listEvents

• listEvents(): Promise<{
      emitter: INopeEventEmitter<any, any, any, IEventAdditionalData>;
      options: IEventOptions;
  }[]>

• Function used to list all available Properties.

  Returns

  Memberof

  NopeBaseModule

  Returns Promise<{
      emitter: INopeEventEmitter<any, any, any, IEventAdditionalData>;
      options: IEventOptions;
  }[]>

listMethods

• listMethods(): Promise<{
      method: ((...args) => Promise<any>);
      options: IServiceOptions<any>;
  }[]>

• Function to return all available Methods. *

  Memberof

  NopeBaseModule

  Returns Promise<{
      method: ((...args) => Promise<any>);
      options: IServiceOptions<any>;
  }[]>

listProperties

• listProperties(): Promise<{
      observable: INopeObservable<any, any, any, IEventAdditionalData>;
      options: IEventOptions;
  }[]>

• Function used to list all available Properties.

  Memberof

  NopeBaseModule

  Returns Promise<{
      observable: INopeObservable<any, any, any, IEventAdditionalData>;
      options: IEventOptions;
  }[]>

registerEvent

• registerEvent<T, S, G>(name, emitter, options): Promise<void>

• Helper Function to register an Event(Emitter) (a Property.)

  Returns

  Memberof

  NopeBaseModule

  Type Parameters

  • T

    Type of the Event(Emitter)

  • S = T

    Setter Type of the Event(Emitter)

  • G = T

    Getter Type of the Event(Emitter)

  Parameters

  • name: string

    Name, which should be used to register the element. The Name will ALLWAYS (automatically) be assembled using the modules identifier an then the name.

  • emitter: INopeObservable<T, S, G, IEventAdditionalData>

    The Event(Emitter) representing the Property

  • options: IEventOptions

    The Options used to define the registration.

  Returns Promise<void>

registerMethod

• registerMethod(name, method, options): Promise<void>

• Function used to register a Method. This Method will be available in the shared network.

  Returns

  Memberof

  NopeBaseModule

  Parameters

  • name: string

    Name of the Method, which is used during registration at the dispatcher

  • method: ((...args) => Promise<any>)

    The function itself. It must be async.

    • • (...args): Promise<any>

      • Parameters

        • Rest ...args: any[]

        Returns Promise<any>

  • options: IServiceOptions<any>

    The Options, used for registering.

  Returns Promise<void>

registerProperty

• registerProperty<T, S, G>(name, observable, options): Promise<void>

• Helper Function to register an Observable (a Property.)

  Returns

  Memberof

  NopeBaseModule

  Type Parameters

  • T

    Type of the Property

  • S = T

    Setter Type of the Property

  • G = T

    Getter Type of the Property

  Parameters

  • name: string

    Name, which should be used to register the element. The Name will ALLWAYS (automatically) be assembled using the modules identifier an then the name.

  • observable: INopeObservable<T, S, G, IEventAdditionalData>

    The Observable representing the Property

  • options: IEventOptions

    The Options used to define the registration.

  Returns Promise<void>

toDescription

• toDescription(): INopeModuleDescription

• Helper function to extract an description of the Module.

  Returns

  a parsed description

  Memberof

  NopeBaseModule

  Returns INopeModuleDescription

unregisterEvent

• unregisterEvent(name): Promise<void>

• Helper Function to unregister an Eventbased Property

  Returns

  Memberof

  NopeBaseModule

  Parameters

  • name: string

    Name of the Property, that has been used to register.

  Returns Promise<void>

unregisterFunction

• unregisterFunction(name): Promise<void>

• Unregister a Function

  Returns

  Memberof

  NopeBaseModule

  Parameters

  • name: string

    Name of the function used during registering.

  Returns Promise<void>

unregisterProperty

• unregisterProperty(name): Promise<void>

• Helper Function to unregister an Observable (a Property.)

  Returns

  Memberof

  NopeBaseModule

  Parameters

  • name: string

    Name of the Property, that has been used to register.

  Returns Promise<void>