Skip to content

Commit 5ea8610

Browse files
committed
docs: fix and improve doc
1 parent 9658ca6 commit 5ea8610

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@ Create data storage that uses a simple key-value method for Node, Browser, Deno,
33

44
[![NPM](https://nodei.co/npm/kv-storage.png?mini=true)](https://www.npmjs.com/package/kv-storage)
55
[![npm version](https://badge.fury.io/js/kv-storage.svg)](https://www.npmjs.com/package/kv-storage)
6+
7+
[Demo](https://codesandbox.io/p/devbox/simple-kv-storage-pzr9ld)
8+
69
## Features
710

811
* ✅ 0 Dependencies
912
* ✅ NoSQL Database
1013
* ✅ Lightwight
1114

12-
## Demo
13-
14-
[https://codesandbox.io/p/devbox/simple-kv-storage-pzr9ld](https://codesandbox.io/p/devbox/simple-kv-storage-pzr9ld)
15-
1615
## Installation
1716

1817
NPM (node, browser, deno, bun, cloudflare)
@@ -55,7 +54,7 @@ CDN
5554
```javascript
5655
//Browser initialization if using CDN
5756

58-
const db = await kvstorage.KVStorage({
57+
const db = await KVStorage({
5958
runtime:'browser',
6059
storageName:'storage'
6160
})
@@ -104,7 +103,7 @@ void async function main() {
104103
//Browser using CDN example
105104

106105
void async function main() {
107-
const db = await kvstorage.KVStorage({
106+
const db = await KVStorage({
108107
runtime:'browser',
109108
storageName:'storage'
110109
})
@@ -200,10 +199,10 @@ storageName = Alphanumeric storage name
200199
databaseBinding = Cloudflare only D1 database binding env
201200
```
202201
Supported runtime :
203-
- [x] `node` use file storage
204-
- [x] `deno` use file storage need `--allow-read --allow-write`
205-
- [x] `browser` use IndexedDB
206-
- [x] `bun` use file storage
202+
- [x] `node` use File System
203+
- [x] `deno` use File System need `--allow-read --allow-write`
204+
- [x] `browser` use [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
205+
- [x] `bun` use File System
207206
- [x] `cloudflare` workers use D1 Database [docs](https://developers.cloudflare.com/d1/get-started/#4-bind-your-worker-to-your-d1-database) example [wrangler.toml](https://github.com/nuzulul/kv-storage/blob/main/wrangler.toml)
208207

209208
### Write key-value pairs

test/test-unit.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,42 @@ export async function test(db:any){
22
let data:Array<any> = []
33
let obj:any = {}
44

5+
//test for create new kv
56
obj={put:await db.put('yes','no'),expected: true}
67
if(obj.put == obj.expected){obj.passed = true}else{obj.passed = false}
78
data.push(obj)
89

10+
//test for get existed kv
911
obj={get:await db.get('yes'),expected: 'no'}
1012
if(obj.get == obj.expected){obj.passed = true}else{obj.passed = false}
1113
data.push(obj)
1214

15+
//test for get non existed kv
1316
obj={get:await db.get('yesyes'),expected: false}
1417
if(obj.get == obj.expected){obj.passed = true}else{obj.passed = false}
1518
data.push(obj)
1619

20+
//test for check existed kv
1721
obj={has:await db.has('yes'),expected: true}
1822
if(obj.has == obj.expected){obj.passed = true}else{obj.passed = false}
1923
data.push(obj)
2024

25+
//test for check non existed kv
2126
obj={has:await db.has('yesyes'),expected: false}
2227
if(obj.has == obj.expected){obj.passed = true}else{obj.passed = false}
2328
data.push(obj)
2429

30+
//test list all kv
2531
obj={list:await db.list(),expected:{keys:["yes"],complete:true}}
2632
if(JSON.stringify(obj.list) == JSON.stringify(obj.expected)){obj.passed = true}else{obj.passed = false}
2733
data.push(obj)
2834

35+
//test delete existed kv
2936
obj={delete:await db.delete('yes'),expected: true}
3037
if(obj.delete == obj.expected){obj.passed = true}else{obj.passed = false}
3138
data.push(obj)
3239

40+
//test delete non existed kv
3341
obj={delete:await db.delete('yesyes'),expected: true}
3442
if(obj.delete == obj.expected){obj.passed = true}else{obj.passed = false}
3543
data.push(obj)

0 commit comments

Comments
 (0)