Interface IGenericNopeModule

Hierarchy

INopeModule
- IGenericNopeModule

Properties

_markedElements

_markedElements: {
    accessor: string;
    options: IEventOptions | IServiceOptions<any>;
    type: "event" | "method" | "prop";
}[]

Internal Element, which is used to store elements, that should be added automaticallay.

Memberof

INopeModule

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

dynamicInstanceMethods

dynamicInstanceMethods: {
[index: string]: (<T>(...args) => INopePromise<T>);
}

Type declaration

[index: string]: (<T>(...args) => INopePromise<T>)
- - <T>(...args): INopePromise<T>
  - Type Parameters
    - T
    Parameters
    - Rest ...args: any
    Returns INopePromise<T>

dynamicInstanceMethodsWithOptions

dynamicInstanceMethodsWithOptions: {
[index: string]: (<T>(options, ...args) => INopePromise<T>);
}

Type declaration

[index: string]: (<T>(options, ...args) => INopePromise<T>)
- - <T>(options, ...args): INopePromise<T>
  - Type Parameters
    - T
    Parameters
    - options: Partial<ICallOptions>
    - Rest ...args: any
    Returns INopePromise<T>

dynamicInstanceProperties

dynamicInstanceProperties: {
[index: string]: INopeObservable<any>;
}

Type declaration

[index: string]: INopeObservable<any>

`Readonly` events

events: {
[index: string]: IEventOptions;
}

Type declaration

[index: string]: IEventOptions

identifier

identifier: string

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

Memberof

INopeModuleDescription

`Readonly` methods

methods: {
[index: string]: IServiceOptions;
}

Contains the provided functions.

key = id of the function

Memberof

INopeModuleDescription

Type declaration

[index: string]: IServiceOptions

`Readonly` properties

properties: {
[index: string]: IEventOptions;
}

Type declaration

[index: string]: IEventOptions

`Readonly` type

type: string

Type of the Module

Memberof

INopeModuleDescription

`Readonly` uiLinks

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

version

version: IVersion

Description of the provided Version of the Module.

Memberof

INopeModuleDescription

Methods

dispose

dispose(): Promise<void>
Function used to Dispose the Module.

Returns

Memberof
IBaseModule

Returns Promise<void>
Inherited from INopeModule.dispose
- Defined in lib/types/nope/nopeModule.interface.ts:201

getIdentifierOf

getIdentifierOf(propOrFunc): string
Helper Function, to extract the Name of the Property or the Identifier.

Returns
{string}

Memberof
INopeModule
Parameters
- propOrFunc: INopeObservable<any, any, any, IEventAdditionalData> | ((...args) => Promise<any>)
Returns string
Inherited from INopeModule.getIdentifierOf
- Defined in lib/types/nope/nopeModule.interface.ts:110

init

init(...args): Promise<void>
Function used to initialze the Module.

Returns

Memberof
IBaseModule
Parameters
- Rest ...args: any[]
Returns Promise<void>
Inherited from INopeModule.init
- Defined in lib/types/nope/nopeModule.interface.ts:193

listMethods

listMethods(): Promise<{
method: ((...args) => Promise<any>);
options: IServiceOptions<any>;
}[]>
Function to list the available Functions of the module. This will hold all available functions (dynamic and static functions).

Returns

Memberof
IBaseModule

Returns Promise<{
method: ((...args) => Promise<any>);
options: IServiceOptions<any>;
}[]>
Inherited from INopeModule.listMethods
- Defined in lib/types/nope/nopeModule.interface.ts:173

listProperties

listProperties(): Promise<{
observable: INopeObservable<any, any, any, IEventAdditionalData>;
options: IEventOptions;
}[]>
Function used to get an List of all registered Properties.

Returns

Memberof
IBaseModule

Returns Promise<{
observable: INopeObservable<any, any, any, IEventAdditionalData>;
options: IEventOptions;
}[]>
Inherited from INopeModule.listProperties
- Defined in lib/types/nope/nopeModule.interface.ts:183

registerMethod

registerMethod(name, method, options): Promise<void>
Function used to register a Function

Returns

Memberof
IBaseModule
Parameters
- name: string
  
  Name of the Function
- method: ((...args) => Promise<any>)
  
  The Function
  - - (...args): Promise<any>
    - Parameters
      
      Rest ...args: any[]
      
      Returns Promise<any>
- options: IServiceOptions<any>
  
  The Options used during subscription
Returns Promise<void>
Inherited from INopeModule.registerMethod
- Defined in lib/types/nope/nopeModule.interface.ts:123

registerProperty

registerProperty<T, S, G>(name, observable, options): Promise<void>
Function to Register a Property. If called for an existing Property, the Data will be updated.

Returns

Memberof
IBaseModule
Type Parameters
- T
  
  Internal Type
- S = T
  
  Setter Type
- G = T
  
  Getter Type
Parameters
- name: string
  
  Name of the Property.
- observable: INopeObservable<T, S, G, IEventAdditionalData>
  
  The Observable.
- options: IEventOptions
  
  The Options which are used during registering the Observable.
Returns Promise<void>
Inherited from INopeModule.registerProperty
- Defined in lib/types/nope/nopeModule.interface.ts:151

toDescription

toDescription(): INopeModuleDescription
Function used to derive a parsable Description of the Module.

Returns

Memberof
INopeModule

Returns INopeModuleDescription
Inherited from INopeModule.toDescription
- Defined in lib/types/nope/nopeModule.interface.ts:209

unregisterFunction

unregisterFunction(name): Promise<void>
Function used to unregister a Function

Returns

Memberof
IBaseModule
Parameters
- name: string
  
  Name of the Function.
Returns Promise<void>
Inherited from INopeModule.unregisterFunction
- Defined in lib/types/nope/nopeModule.interface.ts:136

unregisterProperty

unregisterProperty(name): Promise<void>
Function used to unregister a Property

Returns

Memberof
IBaseModule
Parameters
- name: string
  
  Name of the Property.
Returns Promise<void>
Inherited from INopeModule.unregisterProperty
- Defined in lib/types/nope/nopeModule.interface.ts:164

Interface IGenericNopeModule

Hierarchy

Index

Properties

Methods

Properties

_markedElements

Memberof

author

Memberof

description

Memberof

dynamicInstanceMethods

Type declaration

[index: string]: (<T>(...args) => INopePromise<T>)

Type Parameters

T

Parameters

Rest ...args: any

Returns INopePromise<T>

dynamicInstanceMethodsWithOptions

Type declaration

[index: string]: (<T>(options, ...args) => INopePromise<T>)

Type Parameters

T

Parameters

options: Partial<ICallOptions>

Rest ...args: any

Returns INopePromise<T>

dynamicInstanceProperties

Type declaration

[index: string]: INopeObservable<any>

Readonly events

Type declaration

[index: string]: IEventOptions

identifier

Memberof

Readonly methods

Memberof

Type declaration

[index: string]: IServiceOptions

Readonly properties

Type declaration

[index: string]: IEventOptions

Readonly type

Memberof

Readonly uiLinks

version

Memberof

Methods

dispose

Returns

Memberof

Returns Promise<void>

getIdentifierOf

Returns

Memberof

Parameters

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

Returns string

init

Returns

Memberof

Parameters

Rest ...args: any[]

Returns Promise<void>

listMethods

Returns

Memberof

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

listProperties

Returns

Memberof

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

registerMethod

Returns

Memberof

Parameters

name: string

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

`Rest` ...args: any

`Rest` ...args: any

`Readonly` events

`Readonly` methods

`Readonly` properties

`Readonly` type

`Readonly` uiLinks

`Rest` ...args: any[]

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

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

`Rest` ...args: any[]