oto-storage 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +23 -0
- package/package.json +9 -4
package/LICENSE
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
MIT License
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2025 Diomari Madulara
|
|
3
|
+
Copyright (c) 2025 Diomari Madulara (https://diom.dev)
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
6
|
of this software and associated documentation files (the "Software"), to deal
|
package/README.md
CHANGED
|
@@ -23,6 +23,29 @@ Or with pnpm:
|
|
|
23
23
|
pnpm add oto-storage
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
+
### 📚 Documentation Site (VitePress)
|
|
27
|
+
|
|
28
|
+
This repo includes a VitePress documentation site in `/docs`.
|
|
29
|
+
Live documentation: [https://oto.diom.dev](https://oto.diom.dev)
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# Run docs locally
|
|
33
|
+
npm run docs:dev
|
|
34
|
+
|
|
35
|
+
# Build static docs
|
|
36
|
+
npm run docs:build
|
|
37
|
+
|
|
38
|
+
# Preview built docs
|
|
39
|
+
npm run docs:preview
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Cloudflare Pages deployment settings:
|
|
43
|
+
|
|
44
|
+
- Project root: `/` (repo root)
|
|
45
|
+
- Build command: `npm run docs:build`
|
|
46
|
+
- Output directory: `docs/.vitepress/dist`
|
|
47
|
+
- Environment variable (optional analytics): `GA_MEASUREMENT_ID=G-XXXXXXXXXX`
|
|
48
|
+
|
|
26
49
|
### ⚡ The Problem
|
|
27
50
|
|
|
28
51
|
Working with browser storage usually involves repetitive `JSON.parse` and `JSON.stringify` calls, manual key prefixing to avoid collisions, and a total lack of Type Safety.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oto-storage",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "A lightweight, type-safe wrapper for localStorage and sessionStorage using the Proxy API.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -22,7 +22,10 @@
|
|
|
22
22
|
"test": "vitest run",
|
|
23
23
|
"test:watch": "vitest",
|
|
24
24
|
"lint": "tsc --noEmit",
|
|
25
|
-
"preview": "vite preview"
|
|
25
|
+
"preview": "vite preview",
|
|
26
|
+
"docs:dev": "vitepress dev docs",
|
|
27
|
+
"docs:build": "vitepress build docs && node scripts/inject-ga.mjs",
|
|
28
|
+
"docs:preview": "vitepress preview docs"
|
|
26
29
|
},
|
|
27
30
|
"keywords": [
|
|
28
31
|
"typescript",
|
|
@@ -33,8 +36,9 @@
|
|
|
33
36
|
"dx",
|
|
34
37
|
"storage-wrapper"
|
|
35
38
|
],
|
|
36
|
-
"author": "Diomari Madulara",
|
|
39
|
+
"author": "Diomari Madulara (https://diom.dev)",
|
|
37
40
|
"license": "MIT",
|
|
41
|
+
"homepage": "https://oto.diom.dev",
|
|
38
42
|
"repository": {
|
|
39
43
|
"type": "git",
|
|
40
44
|
"url": "git+https://github.com/diomari/oto-storage.git"
|
|
@@ -44,6 +48,7 @@
|
|
|
44
48
|
"vitest": "^1.2.2",
|
|
45
49
|
"jsdom": "^24.0.0",
|
|
46
50
|
"tsup": "^8.0.1",
|
|
47
|
-
"vite": "^5.1.0"
|
|
51
|
+
"vite": "^5.1.0",
|
|
52
|
+
"vitepress": "^1.6.4"
|
|
48
53
|
}
|
|
49
54
|
}
|