modules.INopeModuleDescription - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Interface: INopeModuleDescription

modules.INopeModuleDescription

Hierarchy

Properties

author

author: IAuthor

The Author of the Module

Memberof

INopeModuleDescription


description

description: string

A Description of the Module. This is used to describe roughly what the module is capable of doing. Consider this as Module a kind of Documentation. Based on the fact, that the module will be offered in the Network, provide a meaning full documentation

Memberof

INopeModuleDescription


events

Readonly events: Object

Index signature

▪ [index: string]: IEventOptions


identifier

identifier: string

Name of the Module. The name of the module must be written in lowercase.

Memberof

INopeModuleDescription


methods

Readonly methods: Object

Contains the provided functions.

key = id of the function

Memberof

INopeModuleDescription

Index signature

▪ [index: string]: IServiceOptions


properties

Readonly properties: Object

Index signature

▪ [index: string]: IEventOptions


type

Readonly type: string

Type of the Module

Memberof

INopeModuleDescription


uiLinks

Readonly uiLinks: { description: string ; link: string ; name: string }[]


version

version: IVersion

Description of the provided Version of the Module.

Memberof

INopeModuleDescription