Skip to content

Commit ea867e8

Browse files
committed
fix : fix bug deno runtime, merge & reduce unused script
1 parent 5e9afc6 commit ea867e8

File tree

8 files changed

+83
-317
lines changed

8 files changed

+83
-317
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npm install kv-storage
2121
```
2222
CDN (browser)
2323
```javascript
24-
<script src="https://cdn.jsdelivr.net/npm/kv-storage@0.0.5/dist/umd/kv-storage.js"></script>
24+
<script src="https://cdn.jsdelivr.net/npm/kv-storage@0.0.6/dist/umd/kv-storage.js"></script>
2525
```
2626

2727
## Initialization
@@ -38,15 +38,17 @@ import {KVStorage} from 'kv-storage'
3838
//Deno import style
3939
import {KVStorage} from 'npm:kv-storage'
4040

41+
//Node, Browser, Deno & Bun Initialization
4142
const db = await KVStorage({
4243
runtime:'node', //node | browser | deno | bun
4344
storageName:'storage'
4445
})
4546

47+
//Cloudflare Initialization
4648
const db = await KVStorage({
4749
runtime:'cloudflare',
48-
storageName:'storage',
49-
databaseBindings:env.D1 //Cloudflare D1 database bindings env
50+
storageName:'storage', //Cloudflare D1 database name
51+
databaseBinding:env.D1 //Cloudflare D1 database binding env
5052
})
5153
```
5254
CDN
@@ -97,7 +99,7 @@ void async function main() {
9799
}()
98100
```
99101
```javascript
100-
<script src="https://cdn.jsdelivr.net/npm/kv-storage@0.0.5/dist/umd/kv-storage.js"></script>
102+
<script src="https://cdn.jsdelivr.net/npm/kv-storage@0.0.6/dist/umd/kv-storage.js"></script>
101103
<script>
102104
//Browser using CDN example
103105

@@ -119,7 +121,7 @@ void async function main() {
119121
```javascript
120122
<script type="module">
121123
//Browser ES Modules example
122-
import {KVStorage} from 'https://cdn.jsdelivr.net/npm/kv-storage@0.0.5/dist/mjs/kv-storage.js'
124+
import {KVStorage} from 'https://cdn.jsdelivr.net/npm/kv-storage@0.0.6/dist/mjs/kv-storage.js'
123125

124126
void async function main() {
125127
const db = await KVStorage({
@@ -162,8 +164,8 @@ export default {
162164

163165
const db = await KVStorage({
164166
runtime:'cloudflare',
165-
storageName:'storage',
166-
databaseBindings:env.D1
167+
storageName:'storage', //Cloudflare D1 database name
168+
databaseBinding:env.D1 //Cloudflare D1 database binding env
167169
})
168170

169171
let data = []
@@ -189,20 +191,20 @@ export default {
189191
await init({
190192
runtime?:string,
191193
storageName?:string,
192-
databaseBindings?:any //Cloudflare only
194+
databaseBinding?:any
193195
})
194196
```
195197
```
196198
runtime = Javascript runtime
197199
storageName = Alphanumeric storage name
198-
databaseBindings = Cloudflare D1 database bindings env
200+
databaseBinding = Cloudflare only D1 database binding env
199201
```
200202
Supported runtime :
201203
- [x] `node`
202204
- [x] `deno` need `--allow-read --allow-write`
203205
- [x] `browser` use IndexedDB
204206
- [x] `bun`
205-
- [x] `cloudflare` workers use D1 Database [docs](https://developers.cloudflare.com/d1/get-started/#4-bind-your-worker-to-your-d1-database)
207+
- [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)
206208

207209
### Write key-value pairs
208210

package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "kv-storage",
3-
"version": "0.0.5",
3+
"version": "0.0.6",
44
"description": "Create data storage that uses a simple key-value method for Node, Browser, Deno, Bun, Cloudflare Workers",
55
"main": "dist/cjs/kv-storage.js",
66
"module": "dist/mjs/kv-storage.js",
@@ -12,8 +12,9 @@
1212
},
1313
"scripts": {
1414
"dev-node": "nodemon -e js,ts --watch src --watch test --exec \"npm run build && npm start\"",
15+
"dev-bun": "nodemon -e js,ts --watch src --watch test --exec \"bun run test/server.ts\"",
1516
"dev-deno": "nodemon -e js,ts --watch src --watch test --exec \"deno run --allow-read --allow-write test/test-deno/server-deno.ts\"",
16-
"dev-cf": "nodemon -e js,ts,html --watch src --watch test --exec \"npm run prepare-public && tsc -p tsconfig-browser.json && wrangler dev --env dev\"",
17+
"dev-cf": "nodemon -e js,ts,html --watch src --watch test --exec \"npm run prepare-public && tsc -p tsconfig-browser.json && wrangler dev\"",
1718
"dev-browser": "nodemon -e js,ts,html --watch src --watch test --exec \"npm run prepare-public && tsc -p tsconfig-browser.json && tsc -p tsconfig-umd.json && rollup -c public/config/rollup.config.js && ts-node test/server-browser.ts\"",
1819
"build-win": "npm run prepare-build-win && tsc -p tsconfig-mjs.json && tsc -p tsconfig-cjs.json && tsc -p tsconfig-umd.json && rollup -c public/config/rollup.config.umd.js && echo {\"type\": \"commonjs\"}>dist\\cjs\\package.json && echo {\"type\": \"module\"}>dist\\mjs\\package.json",
1920
"gh-deploydoc": "npm run typedoc && git add docs -f && git commit -m \"docs\" && npm run gh-deploy && git reset --soft HEAD~ && git restore --staged .",
@@ -27,7 +28,7 @@
2728
"prepare-build-win": "if not exist .\\dist (mkdir dist) else (rmdir /S /Q .\\dist\\)",
2829
"prepare-typedoc": "if not exist .\\docs (mkdir docs) else (rmdir /S /Q .\\docs\\)",
2930
"prepare-public": "if not exist .\\public (mkdir public) else (rmdir /S /Q .\\public\\)",
30-
"typedoc": "npm run prepare-typedoc && typedoc src/kv-storage.ts src/node-kv-storage.ts src/deno-kv-storage.ts src/bun-kv-storage.ts",
31+
"typedoc": "npm run prepare-typedoc && typedoc src/kv-storage.ts src/kv-storage-module.ts",
3132
"gh-deploy": "git push origin :gh-pages && git subtree push --prefix docs origin gh-pages",
3233
"gh-deploy-init": "git push origin && git subtree push --prefix docs origin gh-pages",
3334

src/bun-kv-storage.ts

Lines changed: 0 additions & 121 deletions
This file was deleted.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import fs from 'node:fs'
22

3-
export class DenoKVStorage{
3+
export class KVStorageModule{
44

55
_storageDir:string
66

@@ -28,7 +28,7 @@ export class DenoKVStorage{
2828
}:{
2929
dataDirName?:string,
3030
storageName:string
31-
}): Promise<DenoKVStorage>{
31+
}): Promise<KVStorageModule>{
3232

3333
function isAlphanumeric(str:string) {
3434
return /^[a-zA-Z0-9]+$/.test(str);
@@ -55,7 +55,7 @@ export class DenoKVStorage{
5555
let _dataDirName = "./"+dataDirName
5656
let storageDir = _dataDirName+'/'+storageName
5757
await makeDir(storageDir)
58-
return new DenoKVStorage({storageDir})
58+
return new KVStorageModule({storageDir})
5959
}
6060

6161
public async put(key:string,value:string){

0 commit comments

Comments
 (0)