types.nope - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Namespace: nope

types.nope

Enumerations

Interfaces

References

IAuthor

Re-exports IAuthor


IDispatcherConstructor

Re-exports IDispatcherConstructor


IEventAdditionalData

Re-exports IEventAdditionalData


IEventCallback

Re-exports IEventCallback


IEventOptions

Re-exports IEventOptions


IGenerateInstanceCallback

Re-exports IGenerateInstanceCallback


IGenerateRemoteInstanceCallback

Re-exports IGenerateRemoteInstanceCallback


IGenerateRemoteInstanceForOtherDispatcherCallback

Re-exports IGenerateRemoteInstanceForOtherDispatcherCallback


IGenericNopeModule

Re-exports IGenericNopeModule


IHostOverview

Re-exports IHostOverview


INopeConnectivityManager

Re-exports INopeConnectivityManager


INopeDispatcher

Re-exports INopeDispatcher


INopeDispatcherOptions

Re-exports INopeDispatcherOptions


INopeEventEmitter

Re-exports INopeEventEmitter


INopeINopeConnectivityOptions

Re-exports INopeINopeConnectivityOptions


INopeINopeConnectivityTimeOptions

Re-exports INopeINopeConnectivityTimeOptions


INopeModule

Re-exports INopeModule


INopeModuleDescription

Re-exports INopeModuleDescription


INopeObservable

Re-exports INopeObservable


INopeObserver

Re-exports INopeObserver


INopePartialObserver

Re-exports INopePartialObserver


INopePromise

Re-exports INopePromise


INopeRpcManager

Re-exports INopeRpcManager


INopeSubscriptionOptions

Re-exports INopeSubscriptionOptions


INopeWaitForEventOptions

Re-exports INopeWaitForEventOptions


INopeWaitForObservableChangeOptions

Re-exports INopeWaitForObservableChangeOptions


IObservableType

Re-exports IObservableType


IParsableDescription

Re-exports IParsableDescription


IPartialObserver

Re-exports IPartialObserver


IPipe

Re-exports IPipe


IServiceOptions

Re-exports IServiceOptions


IValidPromise

Re-exports IValidPromise


IVersion

Re-exports IVersion


IWaitForCallback

Re-exports IWaitForCallback


ValidDefaultSelectors

Re-exports ValidDefaultSelectors


ValidSelectorFunction

Re-exports ValidSelectorFunction

Type Aliases

Eventname

Eventname: keyof EventnameToEventType

Valid names of the events.


EventnameToEventType

EventnameToEventType: Object

A Mapping, mapping the event name to the Type and Message.

Type declaration

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

IAvailableInstancesMsg: Object

Type declaration

Name Type Description
dispatcher string The Id of the Dispatcher
instances INopeModuleDescription[] The List of available Instance Creators.

INopeActivationHanlder

INopeActivationHanlder: (_context: interfaces.Context, _instance: any) => any

Type declaration

(_context, _instance): any

Parameters
Name Type
_context interfaces.Context
_instance any
Returns

any


INopeDescriptorSchemaBaseTypes

INopeDescriptorSchemaBaseTypes: "string" | "number" | "integer" | "object" | "array" | "boolean" | "null" | "function"

Valid Descriptor types


INopeDescriptorSchemaTypes

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

INopeTopic<T, S, G>: INopeEventEmitter<T, S, G, ITopicSetContentOptions>

The Topic Type.

Type parameters

Name Type
T any
S T
G T

INopeTopicWithDirectAccess

INopeTopicWithDirectAccess<T, S, G>: INopeObservable<T, S, G, ITopicSetContentOptions>

Type parameters

Name Type
T any
S T
G T

ITaskCancelationMsg

ITaskCancelationMsg: Object

Type declaration

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

TConstructorCallback<I>: (core: INopeCore, identifier: string, ...args: any) => Promise<I>

Type parameters

Name Type
I extends INopeModule = INopeModule

Type declaration

(core, identifier, ...args): Promise<I>

Parameters
Name Type
core INopeCore
identifier string
...args any
Returns

Promise<I>


TGenerateWrapperCallback

TGenerateWrapperCallback<I>: (core: INopeCore, description: INopeModuleDescription, options: { linkEvents: boolean ; linkProperties: boolean }, ...args: any) => Promise<I>

Type parameters

Name Type
I extends INopeModule = INopeModule

Type declaration

(core, description, options, ...args): Promise<I>

Parameters
Name Type
core INopeCore
description INopeModuleDescription
options Object
options.linkEvents boolean
options.linkProperties boolean
...args any
Returns

Promise<I>


TValidAsssignmentChecker

TValidAsssignmentChecker: (module: INopeModuleDescription, usedDispatcher: INopeStatusInfo) => Promise<boolean>

Type declaration

(module, usedDispatcher): Promise<boolean>

Parameters
Name Type
module INopeModuleDescription
usedDispatcher INopeStatusInfo
Returns

Promise<boolean>


ValidCallOptions

ValidCallOptions: Partial<ICallOptions> & { selector?: ValidSelectorFunction } & IExtraData

Variables

Eventnames

Const Eventnames: Eventname[]

List containing all valid Eventnames.

⚠️ **GitHub.com Fallback** ⚠️