@kronos-integration/endpoint 11.0.4 → 11.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +39 -31
  2. package/package.json +11 -11
package/README.md CHANGED
@@ -1,11 +1,13 @@
1
+ [![npm](https://img.shields.io/npm/v/@kronos-integration/endpoint.svg)](https://www.npmjs.com/package/@kronos-integration/endpoint)
1
2
  [![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
2
3
  [![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
4
+ [![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/endpoint\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/endpoint)
5
+ [![downloads](http://img.shields.io/npm/dm/@kronos-integration/endpoint.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/endpoint)
3
6
  [![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/endpoint.svg?style=flat-square)](https://github.com/Kronos-Integration/endpoint/issues)
4
7
  [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fendpoint%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/endpoint/goto)
5
8
  [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
6
9
  [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
7
10
  [![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/endpoint/badge.svg)](https://snyk.io/test/github/Kronos-Integration/endpoint)
8
- [![Coverage Status](https://coveralls.io/repos/Kronos-Integration/endpoint/badge.svg)](https://coveralls.io/github/Kronos-Integration/endpoint)
9
11
 
10
12
  # kronos-endpoint
11
13
 
@@ -37,68 +39,70 @@ Named communication (end)-points inside of kronos
37
39
  * [isOut](#isout)
38
40
  * [direction](#direction)
39
41
  * [jsonAttributes](#jsonattributes)
42
+ * [toJSONWithOptions](#tojsonwithoptions)
43
+ * [Parameters](#parameters-2)
40
44
  * [hasInterceptors](#hasinterceptors)
41
45
  * [connectable](#connectable)
42
- * [Parameters](#parameters-2)
46
+ * [Parameters](#parameters-3)
43
47
  * [hasConnections](#hasconnections)
44
48
  * [isConnected](#isconnected)
45
- * [Parameters](#parameters-3)
46
- * [openConnection](#openconnection)
47
49
  * [Parameters](#parameters-4)
48
- * [closeConnection](#closeconnection)
50
+ * [openConnection](#openconnection)
49
51
  * [Parameters](#parameters-5)
52
+ * [closeConnection](#closeconnection)
53
+ * [Parameters](#parameters-6)
50
54
  * [openConnections](#openconnections)
51
55
  * [closeConnections](#closeconnections)
52
56
  * [connections](#connections)
53
57
  * [addConnection](#addconnection)
54
- * [Parameters](#parameters-6)
55
- * [removeConnection](#removeconnection)
56
58
  * [Parameters](#parameters-7)
57
- * [getConnectionState](#getconnectionstate)
59
+ * [removeConnection](#removeconnection)
58
60
  * [Parameters](#parameters-8)
59
- * [setConnectionState](#setconnectionstate)
61
+ * [getConnectionState](#getconnectionstate)
60
62
  * [Parameters](#parameters-9)
61
- * [didConnect](#didconnect)
63
+ * [setConnectionState](#setconnectionstate)
62
64
  * [Parameters](#parameters-10)
65
+ * [didConnect](#didconnect)
66
+ * [Parameters](#parameters-11)
63
67
  * [isEndpoint](#isendpoint)
64
- * [Parameters](#parameters-11)
65
- * [instanciateInterceptors](#instanciateinterceptors)
66
68
  * [Parameters](#parameters-12)
67
- * [MultiConnectionEndpoint](#multiconnectionendpoint)
69
+ * [instanciateInterceptors](#instanciateinterceptors)
68
70
  * [Parameters](#parameters-13)
71
+ * [MultiConnectionEndpoint](#multiconnectionendpoint)
72
+ * [Parameters](#parameters-14)
69
73
  * [getConnectionState](#getconnectionstate-1)
70
- * [Parameters](#parameters-14)
71
- * [setConnectionState](#setconnectionstate-1)
72
74
  * [Parameters](#parameters-15)
73
- * [removeConnection](#removeconnection-1)
75
+ * [setConnectionState](#setconnectionstate-1)
74
76
  * [Parameters](#parameters-16)
75
- * [isConnected](#isconnected-1)
77
+ * [removeConnection](#removeconnection-1)
76
78
  * [Parameters](#parameters-17)
79
+ * [isConnected](#isconnected-1)
80
+ * [Parameters](#parameters-18)
77
81
  * [connections](#connections-1)
78
82
  * [connections](#connections-2)
79
83
  * [MultiSendEndpoint](#multisendendpoint)
80
- * [Parameters](#parameters-18)
84
+ * [Parameters](#parameters-19)
81
85
  * [isOut](#isout-1)
82
86
  * [ReceivableEndpoint](#receivableendpoint)
83
- * [Parameters](#parameters-19)
87
+ * [Parameters](#parameters-20)
84
88
  * [isIn](#isin-2)
85
89
  * [ReceiveEndpointDefault](#receiveendpointdefault)
86
90
  * [isDefault](#isdefault-1)
87
91
  * [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)
88
92
  * [removeConnection](#removeconnection-2)
89
- * [Parameters](#parameters-20)
93
+ * [Parameters](#parameters-21)
90
94
  * [ReceiveEndpoint](#receiveendpoint)
91
- * [Parameters](#parameters-21)
95
+ * [Parameters](#parameters-22)
92
96
  * [isIn](#isin-3)
93
97
  * [SendEndpointDefault](#sendendpointdefault)
94
98
  * [isDefault](#isdefault-2)
95
99
  * [SendEndpoint](#sendendpoint)
96
- * [Parameters](#parameters-22)
100
+ * [Parameters](#parameters-23)
97
101
  * [isOut](#isout-2)
98
102
  * [addConnection](#addconnection-1)
99
- * [Parameters](#parameters-23)
100
- * [removeConnection](#removeconnection-3)
101
103
  * [Parameters](#parameters-24)
104
+ * [removeConnection](#removeconnection-3)
105
+ * [Parameters](#parameters-25)
102
106
  * [SendReceiveEndpoint](#sendreceiveendpoint)
103
107
  * [isIn](#isin-4)
104
108
 
@@ -173,6 +177,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
173
177
 
174
178
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{includeRuntimeInfo:true}`)
175
179
 
180
+ * `options.includeRuntimeInfo` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** 
181
+
176
182
  ### isIn
177
183
 
178
184
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
@@ -191,6 +197,14 @@ Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
191
197
 
192
198
  Additional attributes to present in json output.
193
199
 
200
+ ### toJSONWithOptions
201
+
202
+ #### Parameters
203
+
204
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
205
+
206
+ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
207
+
194
208
  ### hasInterceptors
195
209
 
196
210
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there is at least one interceptor assigned
@@ -405,9 +419,6 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
405
419
  * `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** of the endpoint (service)
406
420
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
407
421
 
408
- * `options.receive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** reciever function
409
- * `options.receivingInterceptors` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** 
410
-
411
422
  ### isIn
412
423
 
413
424
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true is receive function is present
@@ -486,10 +497,7 @@ Back connections to any further endpoints will not be established
486
497
 
487
498
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** endpoint name
488
499
  * `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** of the endpoint (service)
489
- * `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
490
-
491
- * `options.connected` **([Endpoint](#endpoint) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))?** where te requests are delivered to
492
- * `options.didConnect` **([Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))?** called after receiver is present
500
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
493
501
 
494
502
  ### isOut
495
503
 
package/package.json CHANGED
@@ -1,15 +1,16 @@
1
1
  {
2
2
  "name": "@kronos-integration/endpoint",
3
- "version": "11.0.4",
3
+ "version": "11.0.6",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "provenance": true
7
7
  },
8
+ "packageManager": "npm@11.6.4+sha512.1118cab46a05a50aee6bff5b1b4fa1df18afff89d57465620a3518035026955db87c5bdf9d207b07b7487d99f2490d450cb774655ad63ec2cba7bf1d0ad25d45",
8
9
  "types": "./types/module.d.mts",
9
10
  "exports": {
10
11
  ".": {
11
- "default": "./src/module.mjs",
12
- "types": "./types/module.d.mts"
12
+ "types": "./types/module.d.mts",
13
+ "default": "./src/module.mjs"
13
14
  }
14
15
  },
15
16
  "description": "named communication (end)-points inside of kronos",
@@ -26,20 +27,20 @@
26
27
  "email": "markus.felten@gmx.de"
27
28
  }
28
29
  ],
29
- "license": "BSD-2-Clause",
30
+ "license": "0BSD",
30
31
  "scripts": {
31
32
  "prepare": "node --run prepare:typescript",
32
- "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
33
+ "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
33
34
  "test": "node --run test:ava",
34
35
  "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
35
36
  "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
36
- "docs": "documentation readme --section=API ./src/**/*.mjs",
37
+ "docs": "documentation readme --section=API ./src**/*.mjs",
37
38
  "lint": "node --run lint:docs && node --run lint:typescript",
38
- "lint:docs": "documentation lint ./src/**/*.mjs",
39
- "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
39
+ "lint:docs": "documentation lint ./src**/*.mjs",
40
+ "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
40
41
  },
41
42
  "dependencies": {
42
- "@kronos-integration/interceptor": "^13.0.5"
43
+ "@kronos-integration/interceptor": "^13.1.0"
43
44
  },
44
45
  "devDependencies": {
45
46
  "ava": "^6.4.1",
@@ -65,6 +66,5 @@
65
66
  "arlac77/template-kronos-component",
66
67
  "arlac77/template-typescript"
67
68
  ]
68
- },
69
- "packageManager": "npm@11.6.4+sha512.1118cab46a05a50aee6bff5b1b4fa1df18afff89d57465620a3518035026955db87c5bdf9d207b07b7487d99f2490d450cb774655ad63ec2cba7bf1d0ad25d45"
69
+ }
70
70
  }