types.nope - ZeMA-gGmbH/NoPE-JS GitHub Wiki
types.nope
- IAurevoirMsg
- IAvailableServicesMsg
- IBonjourMsg
- ICallOptions
- IClassDescription
- IClassDescriptor
- ICommunicationBridge
- ICommunicationInterface
- IDataChangedMsg
- IDataPubSubSystem
- IDisposeInstanceMsg
- IEmitter
- IExecutingTaskMsg
- IExternalEventMsg
- IExtraData
- IHost
- IIncrementalChange
- IInstanceCreationMsg
- IInstanceDescriptionMsg
- IMapBasedMergeData
- IMergeData
- INopeCore
- INopeDescriptor
- INopeDescriptorFunctionParameter
- INopeInstanceManager
- INopePackageLoader
- INopePackageLoaderConstructor
- INopeStatusInfo
- IPackageDescription
- IPubSubEmitterOptions
- IPubSubOptions
- IPubSubSystem
- IPubSubSystemConstructor
- IRemoteInstance
- IRequestRpcMsg
- IRequestTaskWithCallback
- IRpcResponseMsg
- IRpcUnregisterMsg
- ITopicSetContentOptions
Re-exports IAuthor
Re-exports IDispatcherConstructor
Re-exports IEventAdditionalData
Re-exports IEventCallback
Re-exports IEventOptions
Re-exports IGenerateInstanceCallback
Re-exports IGenerateRemoteInstanceCallback
Re-exports IGenerateRemoteInstanceForOtherDispatcherCallback
Re-exports IGenericNopeModule
Re-exports IHostOverview
Re-exports INopeConnectivityManager
Re-exports INopeDispatcher
Re-exports INopeDispatcherOptions
Re-exports INopeEventEmitter
Re-exports INopeINopeConnectivityOptions
Re-exports INopeINopeConnectivityTimeOptions
Re-exports INopeModule
Re-exports INopeModuleDescription
Re-exports INopeObservable
Re-exports INopeObserver
Re-exports INopePartialObserver
Re-exports INopePromise
Re-exports INopeRpcManager
Re-exports INopeSubscriptionOptions
Re-exports INopeWaitForEventOptions
Re-exports INopeWaitForObservableChangeOptions
Re-exports IObservableType
Re-exports IParsableDescription
Re-exports IPartialObserver
Re-exports IPipe
Re-exports IServiceOptions
Re-exports IValidPromise
Re-exports IVersion
Re-exports IWaitForCallback
Re-exports ValidDefaultSelectors
Re-exports ValidSelectorFunction
Eventname: keyof EventnameToEventType
Valid names of the events.
EventnameToEventType: Object
A Mapping, mapping the event name to the Type and Message.
| Name | Type |
|---|---|
aurevoir |
IAurevoirMsg |
bonjour |
IBonjourMsg |
dataChanged |
IDataChangedMsg |
event |
IExternalEventMsg |
instancesChanged |
IAvailableInstancesMsg |
rpcRequest |
IRequestRpcMsg |
rpcResponse |
IRpcResponseMsg |
rpcUnregister |
IRpcUnregisterMsg |
servicesChanged |
IAvailableServicesMsg |
statusChanged |
INopeStatusInfo |
taskCancelation |
ITaskCancelationMsg |
tasks |
any |
IAvailableInstancesMsg: Object
| Name | Type | Description |
|---|---|---|
dispatcher |
string |
The Id of the Dispatcher |
instances |
INopeModuleDescription[] |
The List of available Instance Creators. |
INopeActivationHanlder: (_context: interfaces.Context, _instance: any) => any
(_context, _instance): any
| Name | Type |
|---|---|
_context |
interfaces.Context |
_instance |
any |
any
INopeDescriptorSchemaBaseTypes: "string" | "number" | "integer" | "object" | "array" | "boolean" | "null" | "function"
Valid Descriptor types
INopeDescriptorSchemaTypes: INopeDescriptorSchemaBaseTypes | INopeDescriptorSchemaBaseTypes[] | { $ref: string }
A (JSON-Schema and) Nope-Descriptor allows to use multiple types.
Therefore this type uses some additonal types. Alternativly, a reference
$ref can be used to describe some data. Therefore the schema
must be availalbe on the reference.
INopeTopic<T, S, G>: INopeEventEmitter<T, S, G, ITopicSetContentOptions>
The Topic Type.
| Name | Type |
|---|---|
T |
any |
S |
T |
G |
T |
INopeTopicWithDirectAccess<T, S, G>: INopeObservable<T, S, G, ITopicSetContentOptions>
| Name | Type |
|---|---|
T |
any |
S |
T |
G |
T |
ITaskCancelationMsg: Object
| Name | Type | Description |
|---|---|---|
dispatcher |
string |
The Id of the Dispatcher |
quiet? |
boolean |
Flag to indicate, that this task should be canceled quiet. Author M.Karkowski |
reason |
any |
Reason, why the Task has been canceled. |
taskId |
string |
ID of the canceled Task |
TConstructorCallback<I>: (core: INopeCore, identifier: string, ...args: any) => Promise<I>
| Name | Type |
|---|---|
I |
extends INopeModule = INopeModule
|
(core, identifier, ...args): Promise<I>
| Name | Type |
|---|---|
core |
INopeCore |
identifier |
string |
...args |
any |
Promise<I>
TGenerateWrapperCallback<I>: (core: INopeCore, description: INopeModuleDescription, options: { linkEvents: boolean ; linkProperties: boolean }, ...args: any) => Promise<I>
| Name | Type |
|---|---|
I |
extends INopeModule = INopeModule
|
(core, description, options, ...args): Promise<I>
| Name | Type |
|---|---|
core |
INopeCore |
description |
INopeModuleDescription |
options |
Object |
options.linkEvents |
boolean |
options.linkProperties |
boolean |
...args |
any |
Promise<I>
TValidAsssignmentChecker: (module: INopeModuleDescription, usedDispatcher: INopeStatusInfo) => Promise<boolean>
(module, usedDispatcher): Promise<boolean>
| Name | Type |
|---|---|
module |
INopeModuleDescription |
usedDispatcher |
INopeStatusInfo |
Promise<boolean>
ValidCallOptions: Partial<ICallOptions> & { selector?: ValidSelectorFunction } & IExtraData
Const Eventnames: Eventname[]
List containing all valid Eventnames.