@arkstack/cache

中文文档
0.22.2发布于 2026/11/07ES Module近 30 天下载 2320

Arkstack 的缓存模块,为框架提供统一,基于驱动的缓存层.

中文使用文档
文档目录4 节
  1. 存储
  2. 配置
  3. 使用量
  4. 自定义驱动程序

@ arkstack/ cache (帮助)

@arkstack/cache

Arkstack 的缓存模块,为框架提供统一,基于驱动的缓存层.

存储

@arkstack/cache 箱外有四个仓库的船舶:

驱动程序备份商店页:1
memory正在处理 Map默认; 对 dev 和测试非常棒
file磁盘上的 JSON 文件无需外部服务
redisRedis( 通过 ioredis(中文(简体) )分布式; 原子计数器
database通过表格 @arkstack/database重用您的数据库连接

配置

// src/config/cache.ts
import { Arkstack } from '@arkstack/contract'
import type { CacheConfig } from '@arkstack/cache'
import path from 'node:path'

export default (): CacheConfig => ({
  default: env('CACHE_STORE', 'memory'),
  prefix: env('CACHE_PREFIX', 'arkstack_cache_'),
  stores: {
    memory: { driver: 'memory' },
    file: {
      driver: 'file',
      path: path.join(Arkstack.rootDir(), './storage/framework/cache'),
    },
    redis: {
      driver: 'redis',
      host: env('REDIS_HOST', '127.0.0.1'),
      port: env('REDIS_PORT', 6379),
    },
    database: { driver: 'database', table: 'cache' },
  },
})

使用量

import { Cache } from '@arkstack/cache'

// default store
await Cache.put('user:1', user, 60) // ttl in seconds
await Cache.get('user:1')
await Cache.forget('user:1')

// remember: read-through caching
const stats = await Cache.remember('stats', 300, () => computeStats())

// counters
await Cache.increment('hits')
await Cache.decrement('hits', 2)

// a specific store
await Cache.store('redis').forever('flag', true)

Ttl 接受数秒, a Date,或 null (永远).

自定义驱动程序

import { Cache, Store } from '@arkstack/cache'

class TagStore extends Store {
  /* ... implement the Store contract ... */
}

Cache.extend('tags', (config) => new TagStore(config))

然后参考 { driver: 'tags' } 在商店配置.

版本与发布记录

@arkstack/cache 共发布 93 个版本,首次发布于 2026/06/21;过去 12 个月发布了 93 个版本。

版本发布日期距今
0.22.2latest2026/11/07今天
0.22.12026/11/052 天前
0.22.02026/11/052 天前
0.21.12026/11/052 天前
0.21.02026/10/2810 天前
0.20.22026/10/2315 天前

关于 @arkstack/cache 的常见问题

@arkstack/cache 是什么?

Arkstack 的缓存模块,为框架提供统一,基于驱动的缓存层.

如何安装 @arkstack/cache?

在项目目录运行 npm install @arkstack/cache,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@h3ravel/musket(^2.2.13)、@arkstack/contract(^0.22.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@arkstack/cache 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/arkstack__cache 是否存在。

@arkstack/cache 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@arkstack/cache 可以商用吗?

@arkstack/cache 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@arkstack/cache 的下载量有多少?

根据 npm 官方下载统计,@arkstack/cache 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,320 次,日均约 77 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@arkstack/cache 还在维护吗?

最新版本 0.22.2 发布于 2026/11/07(今天);至今共发布 93 个版本,其中过去 12 个月发布了 93 个;首次发布于 2026/06/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。