mefengl/note-unstorage

💾 Unstorage provides an async Key-Value storage API with conventional features like multi driver mounting, watching and working with metadata, dozens of built-in drivers and a tiny core.

代码阅读推荐顺序

建议按以下顺序阅读代码，以理解项目结构和核心功能：

1. 核心类型与接口:
   • src/types.ts - 定义项目中使用到的主要类型和接口。
2. 核心存储逻辑:
   • src/storage.ts - 实现核心的 Storage 类，包含挂载驱动、基本 K/V 操作等。
3. 通用工具函数:
   • src/utils.ts - 提供各种辅助函数，如序列化、路径处理等。
   • src/_utils.ts - 内部使用的工具函数。
4. 入口与导出:
   • src/index.ts - 项目的主入口文件，导出公共 API。
5. 驱动实现:
   • src/drivers/utils/index.ts - 驱动相关的工具函数。
   • src/_drivers.ts - 驱动相关的基础或辅助代码。
   • src/drivers/memory.ts - 了解一个简单的内存驱动实现。
   • src/drivers/fs.ts - 文件系统驱动，了解如何与外部系统交互。
   • src/drivers/overlay.ts - 叠加驱动，理解驱动组合。
   • (浏览 src/drivers/ 目录下的其他驱动以了解特定实现)*
6. HTTP 服务器:
   • src/server.ts - HTTP 存储服务器的实现。
7. 命令行工具:
   • src/cli.ts - 命令行接口实现。
8. 构建与配置:
   • package.json - 项目依赖和脚本。
   • build.config.ts - 构建配置文件。
   • tsconfig.json - TypeScript 配置文件。
   • vite.config.mjs - Vite 构建配置。
   • eslint.config.mjs - ESLint 配置。
9. 测试:
   • test/storage.test.ts - 核心存储接口测试。
   • test/drivers/utils.ts - 测试工具函数。
   • 驱动测试 (Drivers Tests):
     • test/drivers/azure-app-configuration.test.ts
     • test/drivers/azure-cosmos.test.ts
     • test/drivers/azure-key-vault.test.ts
     • test/drivers/azure-storage-blob.test.ts
     • test/drivers/azure-storage-table.test.ts
     • test/drivers/capacitor-preferences.test.ts
     • test/drivers/cloudflare-kv-binding.test.ts
     • test/drivers/cloudflare-kv-http.test.ts
     • test/drivers/cloudflare-r2-binding.test.ts
     • test/drivers/db0.test.ts
     • test/drivers/deno-kv-node.test.ts
     • test/drivers/deno-kv.test.ts
     • test/drivers/fs-lite.test.ts
     • test/drivers/fs.test.ts
     • test/drivers/github.test.ts
     • test/drivers/http.test.ts
     • test/drivers/indexedb.test.ts
     • test/drivers/localstorage.test.ts
     • test/drivers/lru-cache.test.ts
     • test/drivers/memory.test.ts
     • test/drivers/mongodb.test.ts
     • test/drivers/netlify-blobs.test.ts
     • test/drivers/null.test.ts
     • test/drivers/overlay.test.ts
     • test/drivers/redis.test.ts
     • test/drivers/s3.test.ts
     • test/drivers/session-storage.test.ts
     • test/drivers/uploadthing.test.ts
     • test/drivers/upstash.test.ts
     • test/drivers/vercel-blob.test.ts
     • test/drivers/vercel-kv.test.ts

---

💾 Unstorage

Unstorage provides an async Key-Value storage API with conventional features like multi driver mounting, watching and working with metadata, dozens of built-in drivers and a tiny core.

👉 Documentation

Features

• Designed for all environments: Browser, NodeJS, and Workers
• Lots of Built-in drivers
• Asynchronous API
• Unix-style driver mounting to combine storages
• Default in-memory storage
• Tree-shakable utils and tiny core
• Auto JSON value serialization and deserialization
• Binary and raw value support
• State snapshots and hydration
• Storage watcher
• HTTP Storage with built-in server

Usage

Install unstorage npm package:

# yarn
yarn add unstorage

# npm
npm install unstorage

# pnpm
pnpm add unstorage

import { createStorage } from "unstorage";

const storage = createStorage(/* opts */);

await storage.getItem("foo:bar"); // or storage.getItem('/foo/bar')

👉 Check out the the documentation for usage information.

Nightly release channel

You can use the nightly release channel to try the latest changes in the main branch via unstorage-nightly.

If directly using unstorage in your project:

{
  "devDependencies": {
    "unstorage": "npm:unstorage-nightly"
  }
}

If using unstorage via another tool in your project:

{
  "resolutions": {
    "unstorage": "npm:unstorage-nightly"
  }
}

Contribution

• Clone repository
• Install dependencies with pnpm install
• Use pnpm dev to start jest watcher verifying changes
• Use pnpm test before pushing to ensure all tests and lint checks passing

License

MIT