chore: adding storage doc class reference

trust0-project · Nov 5, 2024 · 18ff16c · 18ff16c
1 parent b30a45c
commit 18ff16c
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 9 deletions.
diff --git a/docs/classes/RIDB.md b/docs/classes/RIDB.md
@@ -44,7 +44,7 @@ await db.start({
 })
 ```
 
-A compatible storage should be a class implementing BaseStorage<RIDBTypes.SchemaType> and its methods.
+A compatible storage should be a class implementing [BaseStorage<RIDBTypes.SchemaType> ](../namespaces/RIDBTypes/classes/BaseStorage.md) and its methods.
 
 ### Using with migration plugin
 The migration plugin will automatically migrate your documents for you as you upgrade and change your schemas over the time. 
@@ -106,7 +106,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ts/src/index.ts:145](https://github.com/elribonazo/RIDB/blob/72b425f6219aae20e99e4ee3c2f3723a02ea6440/ts/src/index.ts#L145)
+[ts/src/index.ts:145](https://github.com/elribonazo/RIDB/blob/b30a45c415053519344afdb368cd44f51be96bb3/ts/src/index.ts#L145)
 
 ## Accessors
 
@@ -126,7 +126,7 @@ The collections object.
 
 #### Defined in
 
-[ts/src/index.ts:184](https://github.com/elribonazo/RIDB/blob/72b425f6219aae20e99e4ee3c2f3723a02ea6440/ts/src/index.ts#L184)
+[ts/src/index.ts:184](https://github.com/elribonazo/RIDB/blob/b30a45c415053519344afdb368cd44f51be96bb3/ts/src/index.ts#L184)
 
 ## Methods
 
@@ -152,4 +152,4 @@ A promise that resolves to the database instance.
 
 #### Defined in
 
-[ts/src/index.ts:225](https://github.com/elribonazo/RIDB/blob/72b425f6219aae20e99e4ee3c2f3723a02ea6440/ts/src/index.ts#L225)
+[ts/src/index.ts:225](https://github.com/elribonazo/RIDB/blob/b30a45c415053519344afdb368cd44f51be96bb3/ts/src/index.ts#L225)
diff --git a/docs/variables/SchemaFieldType.md b/docs/variables/SchemaFieldType.md
@@ -34,4 +34,4 @@ An enumeration of schema field types.
 
 ## Defined in
 
-[ts/src/index.ts:280](https://github.com/elribonazo/RIDB/blob/72b425f6219aae20e99e4ee3c2f3723a02ea6440/ts/src/index.ts#L280)
+[ts/src/index.ts:280](https://github.com/elribonazo/RIDB/blob/b30a45c415053519344afdb368cd44f51be96bb3/ts/src/index.ts#L280)
diff --git a/ts/CHANGELOG.md b/ts/CHANGELOG.md
@@ -1,3 +1,10 @@
+## [0.4.5-rc.4](https://github.com/trust0-project/RIDB/compare/v0.4.5-rc.3...v0.4.5-rc.4) (2024-11-05)
+
+
+### Bug Fixes
+
+* adding storage doc class reference ([cae907c](https://github.com/trust0-project/RIDB/commit/cae907c632b51f172a4ebe25b8d604e48b642c1f))
+
 ## [0.4.5-rc.3](https://github.com/trust0-project/RIDB/compare/v0.4.5-rc.2...v0.4.5-rc.3) (2024-11-05)
 
 

diff --git a/ts/package-lock.json b/ts/package-lock.json
diff --git a/ts/package.json b/ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@trust0/ridb",
-  "version": "0.4.5-rc.3",
+  "version": "0.4.5-rc.4",
   "description": "Dependency free wasm db encrypted and secure database wrapper for web and node.",
   "main": "./build/cjs/index.js",
   "publishConfig": {

diff --git a/ts/src/index.ts b/ts/src/index.ts
@@ -89,7 +89,7 @@ class MySimplePlugin extends RIDBTypes.BasePlugin {
  * })
  * ```
  * 
- * A compatible storage should be a class implementing BaseStorage<RIDBTypes.SchemaType> and its methods.
+ * A compatible storage should be a class implementing [BaseStorage<RIDBTypes.SchemaType> ](../namespaces/RIDBTypes/classes/BaseStorage.md) and its methods.
  * 
  * ### Using with migration plugin
  * The migration plugin will automatically migrate your documents for you as you upgrade and change your schemas over the time.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ An enumeration of schema field types.

		## Defined in

		[ts/src/index.ts:280](https://github.com/elribonazo/RIDB/blob/72b425f6219aae20e99e4ee3c2f3723a02ea6440/ts/src/index.ts#L280)
		[ts/src/index.ts:280](https://github.com/elribonazo/RIDB/blob/b30a45c415053519344afdb368cd44f51be96bb3/ts/src/index.ts#L280)