Class NopeGenericWrapper

A Generic Wrapper

Author

M.Karkowski

Export

Hierarchy

NopeBaseModule
- NopeGenericWrapper
  - InjectableNopeGenericWrapper

Constructors

constructor

new NopeGenericWrapper(_core, _emitterFactory, _observableFactory, _linkProperties?, _linkEvents?): NopeGenericWrapper
Creates an instance of NopeGenericModule.

Memberof
NopeGenericModule
Parameters
- _core: INopeCore
- _emitterFactory: (() => INopeEventEmitter<any, any, any, IEventAdditionalData>)
  - - (): INopeEventEmitter<any, any, any, IEventAdditionalData>
    - Returns INopeEventEmitter<any, any, any, IEventAdditionalData>
- _observableFactory: (() => INopeObservable<any, any, any, IEventAdditionalData>)
  - - (): INopeObservable<any, any, any, IEventAdditionalData>
    - Returns INopeObservable<any, any, any, IEventAdditionalData>
- _linkProperties: boolean = true
- _linkEvents: boolean = true
Returns NopeGenericWrapper
Overrides NopeBaseModule.constructor
- Defined in lib/module/GenericWrapper.ts:259

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

A Description of the Author. Use to Mail etc.

Memberof

BaseModule

description

description: string

A Description of the Module. This is used to Describe roughly what the module is capable of doing.

Memberof

BaseModule

dynamicInstanceEvents

dynamicInstanceEvents: {
[index: string]: INopeEventEmitter<any>;
} = {}

Type declaration

[index: string]: INopeEventEmitter<any>

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>

identifier

identifier: string

The Identifier of the Module.

Memberof

BaseModule

uiLinks

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

version

version: IVersion

Description of the provided Version of the Module.

Memberof

BaseModule

Accessors

events

get events(): {
[index: string]: IEventOptions;
}
Public get to receive a Description of the Properties

Memberof
BaseModule

Returns {
[index: string]: IEventOptions;
}
- [index: string]: IEventOptions
Inherited from NopeBaseModule.events
- Defined in lib/module/BaseModule.ts:134

methods

get methods(): {
[index: string]: IServiceOptions;
}
Public getter for the functions

Memberof
BaseModule

Returns {
[index: string]: IServiceOptions;
}
- [index: string]: IServiceOptions
Inherited from NopeBaseModule.methods
- Defined in lib/module/BaseModule.ts:102

properties

get properties(): {
[index: string]: IEventOptions;
}
Public get to receive a Description of the Properties

Memberof
BaseModule

Returns {
[index: string]: IEventOptions;
}
- [index: string]: IEventOptions
Inherited from NopeBaseModule.properties
- Defined in lib/module/BaseModule.ts:118

type

get type(): string
Return the Class Identifier.

Returns string
Overrides NopeBaseModule.type
- Defined in lib/module/GenericWrapper.ts:51
set type(value): void
Return the Class Identifier.
Parameters
- value: string
Returns void
Overrides NopeBaseModule.type
- Defined in lib/module/GenericWrapper.ts:58

Methods

dispose

dispose(): Promise<void>
Function, which is used to unregister the element.

Memberof
NopeBaseModule

Returns Promise<void>
Overrides NopeBaseModule.dispose
- Defined in lib/module/GenericWrapper.ts:313

fromDescription

fromDescription(description, mode?): Promise<void>
Function, used to add the Attributes based on the Description.

Memberof
NopeGenericModule
Parameters
- description: INopeModuleDescription
- Optional mode: "add" | "overwrite" = "overwrite"
Returns Promise<void>
- Defined in lib/module/GenericWrapper.ts:88

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
Inherited from NopeBaseModule.getIdentifierOf
- Defined in lib/module/BaseModule.ts:524

init

init(): Promise<void>
An init Function. Used to initialize the Element.

Returns

Memberof
NopeBaseModule

Returns Promise<void>
Overrides NopeBaseModule.init
- Defined in lib/module/GenericWrapper.ts:305

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;
}[]>
Inherited from NopeBaseModule.listEvents
- Defined in lib/module/BaseModule.ts:410

listMethods

listMethods(): Promise<{
method: (<T>(...args) => INopePromise<T, any>);
options: any;
}[]>
Function to return all available Methods. *

Memberof
NopeBaseModule

Returns Promise<{
method: (<T>(...args) => INopePromise<T, any>);
options: any;
}[]>
Overrides NopeBaseModule.listMethods
- Defined in lib/module/GenericWrapper.ts:269

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;
}[]>
Inherited from NopeBaseModule.listProperties
- Defined in lib/module/BaseModule.ts:398

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>
Inherited from NopeBaseModule.registerEvent
- Defined in lib/module/BaseModule.ts:251

registerMethod

registerMethod(name, func, 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
- func: ((...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>
Overrides NopeBaseModule.registerMethod
- Defined in lib/module/GenericWrapper.ts:289

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>
Overrides NopeBaseModule.registerProperty
- Defined in lib/module/GenericWrapper.ts:281

toDescription

toDescription(): INopeModuleDescription
Helper function to extract an description of the Module.

Returns
a parsed description

Memberof
NopeBaseModule

Returns INopeModuleDescription
Inherited from NopeBaseModule.toDescription
- Defined in lib/module/BaseModule.ts:616

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>
Inherited from NopeBaseModule.unregisterEvent
- Defined in lib/module/BaseModule.ts:359

unregisterFunction

unregisterFunction(name): Promise<void>
Unregister a Function

Returns

Memberof
NopeBaseModule
Parameters
- name: string
  
  Name of the function used during registering.
Returns Promise<void>
Overrides NopeBaseModule.unregisterFunction
- Defined in lib/module/GenericWrapper.ts:297

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>
Overrides NopeBaseModule.unregisterProperty
- Defined in lib/module/GenericWrapper.ts:301

Class NopeGenericWrapper

Author

Export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Memberof

Parameters

_core: INopeCore

_emitterFactory: (() => INopeEventEmitter<any, any, any, IEventAdditionalData>)

Returns INopeEventEmitter<any, any, any, IEventAdditionalData>

_observableFactory: (() => INopeObservable<any, any, any, IEventAdditionalData>)

Returns INopeObservable<any, any, any, IEventAdditionalData>

_linkProperties: boolean = true

_linkEvents: boolean = true

Returns NopeGenericWrapper

Properties

_markedElements

Memberof

author

Memberof

description

Memberof

dynamicInstanceEvents

Type declaration

[index: string]: INopeEventEmitter<any>

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>

identifier

Memberof

uiLinks

version

Memberof

Accessors

events

Memberof

Returns { [index: string]: IEventOptions; }

[index: string]: IEventOptions

methods

Memberof

Returns { [index: string]: IServiceOptions; }

[index: string]: IServiceOptions

properties

Memberof

Returns { [index: string]: IEventOptions; }

[index: string]: IEventOptions

type

Returns string

Parameters

value: string

Returns void

Methods

dispose

Memberof

Returns Promise<void>

fromDescription

Memberof

`Rest` ...args: any

`Rest` ...args: any

Returns {
[index: string]: IEventOptions;
}

Returns {
[index: string]: IServiceOptions;
}

Returns {
[index: string]: IEventOptions;
}

`Optional` mode: "add" | "overwrite" = "overwrite"

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

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

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

`Rest` ...args: any[]