@xyo-network/previous-hash-store-model 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 +119 -10
  2. package/package.json +7 -11
package/README.md CHANGED
@@ -1,23 +1,132 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/previous-hash-store-model
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:
4
13
 
5
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Primary SDK for using XYO Protocol 2.0
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__previous-hash-store-model)
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
+ ### protocol
46
+
47
+ ### packages
48
+
49
+ ### crypto
50
+
51
+ ### packages
52
+
53
+ ### previous-hash-store
54
+
55
+ ### packages
56
+
57
+ ### model
58
+
59
+ ### .temp-typedoc
60
+
61
+ ### interfaces
62
+
63
+ ### <a id="PreviousHashStore"></a>PreviousHashStore
64
+
65
+ [**@xyo-network/previous-hash-store-model**](#../README)
66
+
67
+ ***
68
+
69
+ ## Methods
70
+
71
+ ### getItem()
72
+
73
+ ```ts
74
+ getItem(address): BrandedHash | Promise<BrandedHash | null> | null;
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ #### address
80
+
81
+ `BrandedAddress`
82
+
83
+ ### Returns
84
+
85
+ `BrandedHash` \| `Promise`\<`BrandedHash` \| `null`\> \| `null`
86
+
87
+ ***
88
+
89
+ ### removeItem()
90
+
91
+ ```ts
92
+ removeItem(address): void | Promise<void>;
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ #### address
98
+
99
+ `BrandedAddress`
100
+
101
+ ### Returns
102
+
103
+ `void` \| `Promise`\<`void`\>
104
+
105
+ ***
106
+
107
+ ### setItem()
108
+
109
+ ```ts
110
+ setItem(address, previousHash): void | Promise<void>;
111
+ ```
112
+
113
+ ### Parameters
114
+
115
+ #### address
116
+
117
+ `BrandedAddress`
118
+
119
+ #### previousHash
120
+
121
+ `BrandedHash`
122
+
123
+ ### Returns
18
124
 
19
- ## Credits
125
+ `void` \| `Promise`\<`void`\>
20
126
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
127
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
128
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
129
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/previous-hash-store-model.svg
130
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/previous-hash-store-model
131
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/previous-hash-store-model.svg
132
+ [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/previous-hash-store-model",
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"