@xyo-network/shared 5.3.25 → 5.3.27

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 +147 -10
  2. package/package.json +7 -11
package/README.md CHANGED
@@ -1,23 +1,160 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/shared
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
11
+
12
+ Using npm:
13
+
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
4
17
 
5
- Version: 5.0.2
18
+ Using yarn:
6
19
 
7
- Primary SDK for using XYO Protocol 2.0
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
8
23
 
9
- ## Documentation
24
+ Using pnpm:
10
25
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__shared)
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
+ ### shared
46
+
47
+ ### .temp-typedoc
48
+
49
+ ### interfaces
50
+
51
+ ### <a id="Job"></a>Job
52
+
53
+ [**@xyo-network/shared**](#../README)
54
+
55
+ ***
56
+
57
+ ## Properties
58
+
59
+ ### name
60
+
61
+ ```ts
62
+ name: string;
63
+ ```
64
+
65
+ ***
66
+
67
+ ### onComplete?
68
+
69
+ ```ts
70
+ optional onComplete?: VoidFunction;
71
+ ```
72
+
73
+ ***
74
+
75
+ ### onFail?
76
+
77
+ ```ts
78
+ optional onFail?: VoidFunction;
79
+ ```
80
+
81
+ ***
82
+
83
+ ### onStart?
84
+
85
+ ```ts
86
+ optional onStart?: VoidFunction;
87
+ ```
88
+
89
+ ***
90
+
91
+ ### onSuccess?
92
+
93
+ ```ts
94
+ optional onSuccess?: VoidFunction;
95
+ ```
96
+
97
+ ***
98
+
99
+ ### schedule
100
+
101
+ ```ts
102
+ schedule: string;
103
+ ```
104
+
105
+ ***
106
+
107
+ ### task
108
+
109
+ ```ts
110
+ task: Task;
111
+ ```
112
+
113
+ ### <a id="JobProvider"></a>JobProvider
114
+
115
+ [**@xyo-network/shared**](#../README)
116
+
117
+ ***
118
+
119
+ ## Accessors
120
+
121
+ ### jobs
122
+
123
+ ### Get Signature
124
+
125
+ ```ts
126
+ get jobs(): Job[];
127
+ ```
128
+
129
+ #### Returns
130
+
131
+ [`Job`](#Job)[]
132
+
133
+ ### type-aliases
134
+
135
+ ### <a id="VoidFunction"></a>VoidFunction
136
+
137
+ [**@xyo-network/shared**](#../README)
138
+
139
+ ***
140
+
141
+ ```ts
142
+ type VoidFunction = (...anyArguments) => void;
143
+ ```
144
+
145
+ ## Parameters
146
+
147
+ ### anyArguments
148
+
149
+ ...`unknown`[]
150
+
151
+ ## Returns
18
152
 
19
- ## Credits
153
+ `void`
20
154
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
155
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
156
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
157
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/shared.svg
158
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/shared
159
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/shared.svg
160
+ [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/shared",
3
- "version": "5.3.25",
3
+ "version": "5.3.27",
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,20 +37,16 @@
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",
45
- "acorn": "^8.16.0",
40
+ "@xylabs/sdk-js": "^5.0.94",
41
+ "@xylabs/ts-scripts-common": "~7.7.15",
42
+ "@xylabs/ts-scripts-pnpm": "~7.7.15",
43
+ "@xylabs/tsconfig": "~7.7.15",
46
44
  "axios": "^1.14.0",
47
- "esbuild": "^0.28.0",
48
45
  "typescript": "~5.9.3",
49
46
  "zod": "^4.3.6"
50
47
  },
51
48
  "peerDependencies": {
52
- "@xylabs/sdk-js": "^5",
53
- "zod": "^4"
49
+ "@xylabs/sdk-js": "^5"
54
50
  },
55
51
  "publishConfig": {
56
52
  "access": "public"