@xyo-network/module-event-emitter 5.3.24 → 5.3.26

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 +95 -10
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -1,23 +1,108 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/module-event-emitter
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
4
11
 
5
- Version: 5.0.2
12
+ Using npm:
6
13
 
7
- Primary SDK for using XYO Protocol 2.0
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
8
17
 
9
- ## Documentation
18
+ Using yarn:
10
19
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-event-emitter)
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
23
+
24
+ Using pnpm:
25
+
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### modules
46
+
47
+ ### packages
48
+
49
+ ### module
50
+
51
+ ### packages
52
+
53
+ ### emitter
54
+
55
+ ### .temp-typedoc
56
+
57
+ ### classes
58
+
59
+ ### <a id="ModuleBaseEmitter"></a>ModuleBaseEmitter
60
+
61
+ [**@xyo-network/module-event-emitter**](#../README)
62
+
63
+ ***
64
+
65
+ ## Extends
66
+
67
+ - `BaseEmitter`\<`TParams`, `TEventData`\>
68
+
69
+ ## Type Parameters
70
+
71
+ ### TParams
72
+
73
+ `TParams` *extends* `BaseParams` = `BaseParams`
74
+
75
+ ### TEventData
76
+
77
+ `TEventData` *extends* `EventData` = `EventData`
78
+
79
+ ## Constructors
80
+
81
+ ### Constructor
82
+
83
+ ```ts
84
+ new ModuleBaseEmitter<TParams, TEventData>(params): ModuleBaseEmitter<TParams, TEventData>;
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ #### params
90
+
91
+ `BaseParams`\<`TParams`\>
92
+
93
+ ### Returns
94
+
95
+ `ModuleBaseEmitter`\<`TParams`, `TEventData`\>
96
+
97
+ ### Inherited from
18
98
 
19
- ## Credits
99
+ ```ts
100
+ BaseEmitter<TParams, TEventData>.constructor
101
+ ```
20
102
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
103
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
104
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
105
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/module-event-emitter.svg
106
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/module-event-emitter
107
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/module-event-emitter.svg
108
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/module-event-emitter",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -37,11 +37,11 @@
37
37
  ],
38
38
  "devDependencies": {
39
39
  "@opentelemetry/api": "^1.9.1",
40
- "@types/node": "^25.5.0",
41
- "@xylabs/sdk-js": "^5.0.93",
42
- "@xylabs/ts-scripts-common": "~7.6.16",
43
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
44
- "@xylabs/tsconfig": "~7.6.16",
40
+ "@types/node": "^25.5.2",
41
+ "@xylabs/sdk-js": "^5.0.94",
42
+ "@xylabs/ts-scripts-common": "~7.7.5",
43
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
44
+ "@xylabs/tsconfig": "~7.7.5",
45
45
  "acorn": "^8.16.0",
46
46
  "axios": "^1.14.0",
47
47
  "esbuild": "^0.28.0",