keyv - updating readme with fixes and logo (#1196)

* keyv - updating readme with fixes and logo * Update package.json * removing tiered * Update package.json
jaredwray · Nov 9, 2024 · d2e9234 · d2e9234
1 parent 76cbff5
commit d2e9234
Show file tree

Hide file tree

Showing 14 changed files with 7 additions and 554 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,4 @@
-<h1 align="center">
-	<img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv">
-	<br>
-	<br>
-</h1>
+<h1 align="center"><img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv"></h1>
 
 > Simple key-value storage with support for multiple backends
 

diff --git a/packages/compress-brotli/package.json b/packages/compress-brotli/package.json
@@ -55,7 +55,7 @@
 	"dependencies": {
 		"@keyv/serialize": "*",
 		"compress-brotli": "^1.3.12",
-		"keyv": "*"
+		"keyv": "^5.2.1"
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",

diff --git a/packages/keyv/README.md b/packages/keyv/README.md
@@ -1,4 +1,4 @@
-[<img width="250" align="center" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)
+<h1 align="center"><img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv"></h1>
 
 > Simple key-value storage with support for multiple backends
 

diff --git a/packages/keyv/package.json b/packages/keyv/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "5.2.0",
+	"version": "5.2.1",
 	"description": "Simple key-value storage with support for multiple backends",
 	"type": "module",
 	"main": "dist/index.cjs",

diff --git a/packages/keyv/src/index.ts b/packages/keyv/src/index.ts
@@ -12,6 +12,8 @@ export type DeserializedData<Value> = {
 export interface CompressionAdapter {
 	compress(value: any, options?: any): Promise<any>;
 	decompress(value: any, options?: any): Promise<any>;
+	serialize<Value>(data: DeserializedData<Value>): Promise<string> | string;
+	deserialize<Value>(data: string): Promise<DeserializedData<Value> | undefined> | DeserializedData<Value> | undefined;
 }
 
 export type Serialize = <Value>(data: DeserializedData<Value>) => Promise<string> | string;

diff --git a/packages/tiered/LICENSE b/packages/tiered/LICENSE
diff --git a/packages/tiered/README.md b/packages/tiered/README.md
diff --git a/packages/tiered/package.json b/packages/tiered/package.json
diff --git a/packages/tiered/src/index.ts b/packages/tiered/src/index.ts
diff --git a/packages/tiered/src/types.ts b/packages/tiered/src/types.ts