@twin.org/entity-storage-connector-file 0.0.1-next.27 → 0.0.1-next.29

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 (3) hide show
  1. package/docs/changelog.md +32 -0
  2. package/docs/reference/classes/FileEntityStorageConnector.md +11 -9
  3. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # @twin.org/entity-storage-connector-file - Changelog
2
2
 
3
+ ## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.28...entity-storage-connector-file-v0.0.1-next.29) (2025-04-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/entity-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
16
+ * devDependencies
17
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
18
+
19
+ ## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.27...entity-storage-connector-file-v0.0.1-next.28) (2025-04-09)
20
+
21
+
22
+ ### Miscellaneous Chores
23
+
24
+ * **entity-storage-connector-file:** Synchronize repo versions
25
+
26
+
27
+ ### Dependencies
28
+
29
+ * The following workspace dependencies were updated
30
+ * dependencies
31
+ * @twin.org/entity-storage-models bumped from 0.0.1-next.27 to 0.0.1-next.28
32
+ * devDependencies
33
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
34
+
3
35
  ## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.26...entity-storage-connector-file-v0.0.1-next.27) (2025-03-28)
4
36
 
5
37
 
package/docs/reference/classes/FileEntityStorageConnector.md CHANGED
@@ -4,7 +4,9 @@ Class for performing entity storage operations in file.
4
4
 
5
5
  ## Type Parameters
6
6
 
7
- • **T** = `unknown`
7
+ ### T
8
+
9
+ `T` = `unknown`
8
10
 
9
11
  ## Implements
10
12
 
@@ -12,9 +14,9 @@ Class for performing entity storage operations in file.
12
14
 
13
15
  ## Constructors
14
16
 
15
- ### new FileEntityStorageConnector()
17
+ ### Constructor
16
18
 
17
- > **new FileEntityStorageConnector**\<`T`\>(`options`): [`FileEntityStorageConnector`](FileEntityStorageConnector.md)\<`T`\>
19
+ > **new FileEntityStorageConnector**\<`T`\>(`options`): `FileEntityStorageConnector`\<`T`\>
18
20
 
19
21
  Create a new instance of FileEntityStorageConnector.
20
22
 
@@ -28,7 +30,7 @@ The options for the connector.
28
30
 
29
31
  #### Returns
30
32
 
31
- [`FileEntityStorageConnector`](FileEntityStorageConnector.md)\<`T`\>
33
+ `FileEntityStorageConnector`\<`T`\>
32
34
 
33
35
  ## Properties
34
36
 
@@ -46,7 +48,7 @@ Runtime name for the class.
46
48
 
47
49
  ### bootstrap()
48
50
 
49
- > **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
51
+ > **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
50
52
 
51
53
  Bootstrap the connector by creating and initializing any resources it needs.
52
54
 
@@ -90,7 +92,7 @@ The schema for the entities.
90
92
 
91
93
  ### get()
92
94
 
93
- > **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
95
+ > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
94
96
 
95
97
  Get an entity.
96
98
 
@@ -128,7 +130,7 @@ The object if it can be found or undefined.
128
130
 
129
131
  ### set()
130
132
 
131
- > **set**(`entity`, `conditions`?): `Promise`\<`void`\>
133
+ > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
132
134
 
133
135
  Set an entity.
134
136
 
@@ -160,7 +162,7 @@ The id of the entity.
160
162
 
161
163
  ### remove()
162
164
 
163
- > **remove**(`id`, `conditions`?): `Promise`\<`void`\>
165
+ > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
164
166
 
165
167
  Remove the entity.
166
168
 
@@ -192,7 +194,7 @@ Nothing.
192
194
 
193
195
  ### query()
194
196
 
195
- > **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
197
+ > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
196
198
 
197
199
  Find all the entities which match the conditions.
198
200
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/entity-storage-connector-file",
3
- "version": "0.0.1-next.27",
3
+ "version": "0.0.1-next.29",
4
4
  "description": "Entity Storage connector implementation using file storage",
5
5
  "repository": {
6
6
  "type": "git",
@@ -16,7 +16,7 @@
16
16
  "dependencies": {
17
17
  "@twin.org/core": "next",
18
18
  "@twin.org/entity": "next",
19
- "@twin.org/entity-storage-models": "0.0.1-next.27",
19
+ "@twin.org/entity-storage-models": "0.0.1-next.29",
20
20
  "@twin.org/logging-models": "next",
21
21
  "@twin.org/nameof": "next"
22
22
  },