@universal-packages/dynamic-api - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

DynamicApi.d.ts

@@ -0,3 +1,5 @@
+/// <reference types="node" />
+import { EventEmitter } from 'stream';
 import { DynamicApiOptions, Dynamics } from './DynamicApi.types';
-export default class DynamicApi<D extends Record<string, any>> {
+export default class DynamicApi<D extends Record<string, any>> extends EventEmitter {
     readonly options: DynamicApiOptions;
@@ -4,0 +6,0 @@ readonly dynamics: Dynamics;

DynamicApi.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const module_loader_1 = require("@universal-packages/module-loader");
-class DynamicApi {
+const stream_1 = require("stream");
+class DynamicApi extends stream_1.EventEmitter {
     constructor(options) {
+        super();
         this.dynamics = {};
@@ -7,0 +9,0 @@ this.options = { ...options };

package.json

 {
   "name": "@universal-packages/dynamic-api",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Dynamic decoupling-adapting system",
@@ -5,0 +5,0 @@ "author": "David De Anda <[e-mail]> (https://github.com/universal-packages)",

README.md

@@ -164,2 +164,22 @@ # Dynamic API
 
+## Even Emitter
+
+DynamicApi is an emitter, it does not emit anything by itself but you can use it to communicate to other parts of your app what is going on in your dynamics.
+
+```js
+import { Dynamic } from '@universal-packages/dynamic-api'
+
+@Dynamic('calculate')
+export default class CalculateDynamic {
+  public async perform(payload, dynamicApi) {
+    dynamicApi.emit('event', 'A calculation was done')
+    if(payload.fast) {
+      return 'I did it fast'
+    } else {
+      return 'I was slow'
+    }
+  }
+}
+```
+
 ## Typescript
@@ -166,0 +186,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26344

increased by2.85%

Lines of code

256

increased by1.59%

Number of lines in readme file

216

increased by10.2%

No dependency changes