From 03b38f7f668cea2d91f4622a0838cb9d0e07d24d Mon Sep 17 00:00:00 2001 From: Martin Karkowski Date: Fri, 28 Jan 2022 14:38:33 +0100 Subject: [PATCH] fixing docu --- 00-compile.bat | 2 ++ lib/module/BaseModule.injectable.ts | 9 +++------ lib/module/BaseModule.ts | 7 ++----- lib/module/GenericWrapper.injectable.ts | 15 ++++++--------- lib/module/GenericWrapper.ts | 5 +---- lib/module/index.ts | 4 +--- lib/observables/nopeObservable.injectable.ts | 3 --- lib/observables/nopeObservable.spec.ts | 3 --- lib/observables/nopeObservable.ts | 5 +---- package.json | 2 +- 10 files changed, 17 insertions(+), 38 deletions(-) diff --git a/00-compile.bat b/00-compile.bat index fc7e332..c9d4954 100644 --- a/00-compile.bat +++ b/00-compile.bat @@ -6,6 +6,8 @@ echo Compiling Backend REM Add the Node Options for SSL these are requrired since Node v.17 set NODE_OPTIONS=--openssl-legacy-provider +call $env:NODE_OPTIONS="--openssl-legacy-provider" + (npm run-script prettier-format) && ( (npm run-script compile-nodejs) && ( diff --git a/lib/module/BaseModule.injectable.ts b/lib/module/BaseModule.injectable.ts index 624181b..e62034c 100644 --- a/lib/module/BaseModule.injectable.ts +++ b/lib/module/BaseModule.injectable.ts @@ -1,14 +1,11 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-10-12 17:54:08 - * @modify date 2021-11-11 11:28:29 - * @desc [description] */ import { inject, injectable } from "inversify"; +import { INopeCore } from "../index.browser"; import { DISPATCHER_INSTANCE } from "../symbols/identifiers"; -import { INopeDispatcher } from "../types/nope/nopeDispatcher.interface"; import { INopeModule } from "../types/nope/nopeModule.interface"; import { NopeBaseModule } from "./BaseModule"; @@ -28,7 +25,7 @@ export class InjectableNopeBaseModule extends NopeBaseModule { * Creates an instance of BaseModule. * @memberof InjectableNopeBaseModule */ - constructor(@inject(DISPATCHER_INSTANCE) _dispatcher: INopeDispatcher) { - super(_dispatcher); + constructor(@inject(DISPATCHER_INSTANCE) _core: INopeCore) { + super(_core); } } diff --git a/lib/module/BaseModule.ts b/lib/module/BaseModule.ts index 45a3215..3c485bd 100644 --- a/lib/module/BaseModule.ts +++ b/lib/module/BaseModule.ts @@ -1,9 +1,6 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-10-12 17:54:08 - * @modify date 2020-12-02 07:35:09 - * @desc [description] */ import { ILogger } from "js-logger"; @@ -13,7 +10,7 @@ import { getPropertyPath, isEmitterPathCorrect, isMethodPathCorrect, - isPropertyPathCorrect, + isPropertyPathCorrect } from "../helpers/dispatcherPathes"; import { deepClone } from "../helpers/objectMethods"; import { getNopeLogger } from "../logger/getLogger"; @@ -24,7 +21,7 @@ import { IFunctionOptions, INopeModule, INopeModuleDescription, - IVersion, + IVersion } from "../types/nope/nopeModule.interface"; import { INopeObservable } from "../types/nope/nopeObservable.interface"; diff --git a/lib/module/GenericWrapper.injectable.ts b/lib/module/GenericWrapper.injectable.ts index adf6df5..799d5ec 100644 --- a/lib/module/GenericWrapper.injectable.ts +++ b/lib/module/GenericWrapper.injectable.ts @@ -1,17 +1,14 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-10-12 18:53:00 - * @modify date 2020-12-02 07:35:54 - * @desc [description] */ import { inject, injectable } from "inversify"; +import { INopeCore } from "../index.browser"; import { DISPATCHER_INSTANCE, - OBSERVABLE_FACTORY, + OBSERVABLE_FACTORY } from "../symbols/identifiers"; -import { INopeDispatcher } from "../types/nope/nopeDispatcher.interface"; import { INopeObservable } from "../types/nope/nopeObservable.interface"; import { NopeGenericWrapper } from "./GenericWrapper"; @@ -19,14 +16,14 @@ import { NopeGenericWrapper } from "./GenericWrapper"; export class InjectableNopeGenericWrapper extends NopeGenericWrapper { /** * Creates an instance of NopeGenericModule. - * @param {INopeDispatcher} _dispatcher - * @param {() => INopeObservable} _observableFactory + * @param {INopeCore} _core The NopeCore-Element. Usally is provided as dispatcher + * @param {() => INopeObservable} _observableFactory A Factory, to generate some Observables. * @memberof NopeGenericModule */ constructor( - @inject(DISPATCHER_INSTANCE) _dispatcher: INopeDispatcher, + @inject(DISPATCHER_INSTANCE) _core: INopeCore, @inject(OBSERVABLE_FACTORY) _observableFactory: () => INopeObservable ) { - super(_dispatcher, _observableFactory); + super(_core, _observableFactory); } } diff --git a/lib/module/GenericWrapper.ts b/lib/module/GenericWrapper.ts index c3dc2ae..5e0af44 100644 --- a/lib/module/GenericWrapper.ts +++ b/lib/module/GenericWrapper.ts @@ -1,9 +1,6 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-10-12 18:53:00 - * @modify date 2020-12-30 16:48:42 - * @desc [description] */ import { deepClone } from "../helpers/objectMethods"; @@ -14,7 +11,7 @@ import { INopeDispatcher } from "../types/nope/nopeDispatcher.interface"; import { IEventOptions, IFunctionOptions, - INopeModuleDescription, + INopeModuleDescription } from "../types/nope/nopeModule.interface"; import { INopeObservable } from "../types/nope/nopeObservable.interface"; import { INopePromise } from "../types/nope/nopePromise.interface"; diff --git a/lib/module/index.ts b/lib/module/index.ts index a326cb1..1cc731d 100644 --- a/lib/module/index.ts +++ b/lib/module/index.ts @@ -1,9 +1,6 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2021-08-27 20:28:44 - * @modify date 2021-11-11 11:30:40 - * @desc [description] */ export * from "../types/nope/nopeModule.interface"; @@ -11,3 +8,4 @@ export { NopeBaseModule } from "./BaseModule"; export { InjectableNopeBaseModule } from "./BaseModule.injectable"; export { NopeGenericWrapper } from "./GenericWrapper"; export { InjectableNopeGenericWrapper } from "./GenericWrapper.injectable"; + diff --git a/lib/observables/nopeObservable.injectable.ts b/lib/observables/nopeObservable.injectable.ts index a50041c..f651bca 100644 --- a/lib/observables/nopeObservable.injectable.ts +++ b/lib/observables/nopeObservable.injectable.ts @@ -1,9 +1,6 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-11-23 08:06:30 - * @modify date 2020-12-02 07:38:10 - * @desc [description] */ import { injectable } from "inversify"; diff --git a/lib/observables/nopeObservable.spec.ts b/lib/observables/nopeObservable.spec.ts index a4f0bb9..5726a15 100644 --- a/lib/observables/nopeObservable.spec.ts +++ b/lib/observables/nopeObservable.spec.ts @@ -1,9 +1,6 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-11-23 08:06:30 - * @modify date 2021-10-19 17:55:35 - * @desc [description] */ import { assert } from "chai"; import { beforeEach, describe, it } from "mocha"; diff --git a/lib/observables/nopeObservable.ts b/lib/observables/nopeObservable.ts index b1953c9..a5a0665 100644 --- a/lib/observables/nopeObservable.ts +++ b/lib/observables/nopeObservable.ts @@ -1,9 +1,6 @@ /** * @author Martin Karkowski * @email m.karkowski@zema.de - * @create date 2020-11-23 08:06:30 - * @modify date 2021-11-14 09:03:39 - * @desc [description] */ import { BehaviorSubject } from "rxjs"; @@ -18,7 +15,7 @@ import { INopeObserver, INopePartialObserver, INopeSubscriptionOptions, - IObservableType, + IObservableType } from "../types/nope/index"; const logger = getNopeLogger("obervable"); diff --git a/package.json b/package.json index 87b92cf..57261cc 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "compile-nodejs": "tsc -p ./tsconfig.json", "compile-browser": "tsc -p ./tsconfig.browser.json", "build": "npx webpack -c webpack-typescript.config.js", - "doc": "npx jsdoc ./dist/**/* -d docs", + "doc": "npx typedoc", "start": "node ./dist/cli/repl.js", "prettier-format": "run-script-os", "prettier-format:win32": "prettier \"./lib/**/*.ts\" --write",