Skip to content

Commit d2e9234

Browse files
authoredNov 9, 2024··
keyv - updating readme with fixes and logo (#1196)
* keyv - updating readme with fixes and logo * Update package.json * removing tiered * Update package.json
1 parent 76cbff5 commit d2e9234

File tree

14 files changed

+7
-554
lines changed

14 files changed

+7
-554
lines changed
 

‎README.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
<h1 align="center">
2-
<img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv">
3-
<br>
4-
<br>
5-
</h1>
1+
<h1 align="center"><img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv"></h1>
62

73
> Simple key-value storage with support for multiple backends
84

‎packages/compress-brotli/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"dependencies": {
5656
"@keyv/serialize": "*",
5757
"compress-brotli": "^1.3.12",
58-
"keyv": "*"
58+
"keyv": "^5.2.1"
5959
},
6060
"devDependencies": {
6161
"@keyv/test-suite": "*",

‎packages/keyv/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[<img width="250" align="center" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)
1+
<h1 align="center"><img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv"></h1>
22

33
> Simple key-value storage with support for multiple backends
44

‎packages/keyv/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "keyv",
3-
"version": "5.2.0",
3+
"version": "5.2.1",
44
"description": "Simple key-value storage with support for multiple backends",
55
"type": "module",
66
"main": "dist/index.cjs",

‎packages/keyv/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ export type DeserializedData<Value> = {
1212
export interface CompressionAdapter {
1313
compress(value: any, options?: any): Promise<any>;
1414
decompress(value: any, options?: any): Promise<any>;
15+
serialize<Value>(data: DeserializedData<Value>): Promise<string> | string;
16+
deserialize<Value>(data: string): Promise<DeserializedData<Value> | undefined> | DeserializedData<Value> | undefined;
1517
}
1618

1719
export type Serialize = <Value>(data: DeserializedData<Value>) => Promise<string> | string;

‎packages/tiered/LICENSE

-22
This file was deleted.

‎packages/tiered/README.md

-74
This file was deleted.

‎packages/tiered/package.json

-78
This file was deleted.

‎packages/tiered/src/index.ts

-119
This file was deleted.

‎packages/tiered/src/types.ts

-16
This file was deleted.

‎packages/tiered/test/test.ts

-206
This file was deleted.

‎packages/tiered/tsconfig.json

-26
This file was deleted.

‎packages/tiered/vitest.config.ts

-4
This file was deleted.

‎packages/website/src/docs.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ async function copyCompressionDocs() {
6969
}
7070

7171
function cleanDocumentFromImage(document: string) {
72-
document = document.replace(`[<img width="250" align="center" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)`, "");
72+
document = document.replace(`<h1 align="center"><img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv"></h1>`, "");
7373
document = document.replace(`[<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)`, "");
7474
document = document.replace(`[<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)`, "");
7575
return document;

0 commit comments

Comments
 (0)
Please sign in to comment.