@grest-ts/context

中文文档
0.0.101发布于 2026/11/02MITTypeScriptES Module零依赖近 30 天下载 5809

等级化合成上下文

中文使用文档
文档目录8 节
  1. 你什么时候需要它?
  2. 基本用法实例: 通过服务认证背景
  3. 基本用途
  4. 定义上下文键
  5. 设置和获取背景
  6. 使用 GGContextStore 静态助手
  7. 分支
  8. Async 上下文帮助工具

部分 灰尘 框架. 文档 | 所有软件包

背景包 (@ grest- ts/ context) (中文(简体) )

使用 Async LocalStorage 请求范围上下文存储. 用于单个请求、任务或信件处理过程中存在的短寿命数据,例如跟踪ID、认证数据或请求 元数据.

你什么时候需要它?

  • 框架一级:框架使用GGContext传播请求数据,如痕量ID,认证,并通过调用堆栈请求元数据.
  • 你的密码: 当您需要访问请求特定数据而不通过每个函数时使用它.

注: GGContext 用于 请求范围数据 (短寿. 用于长寿服务 GGLocator 换句话说.

基本用法实例: 通过服务认证背景

// Define auth context key
const AuthUserKey = new GGContextKey("authUser", IsObject({id: IsString, role: IsString}))

// ServiceA - called by HTTP handler, auth is already set in context
class ServiceA {
    async updateDocument(docId: string, content: string) {
        // No need to pass user - ServiceB reads it from context
        await serviceB.saveDocument(docId, content)
    }
}

// ServiceB - deeper in the call chain
class ServiceB {
    async saveDocument(docId: string, content: string) {
        if (AuthUserKey.get()?.role !== "admin") throw new FORBIDDEN()
        // ... save document
    }
}

基本用途

定义上下文键

import {GGContextKey} from "@grest-ts/context"
import {t} from "@grest-ts/schema"

const RequestIdKey = new GGContextKey("requestId", t.string())

// With default value
const DebugModeKey = new GGContextKey("debugMode", t.boolean(), {
    defaultValue: false,
    description: "Enable debug logging for this request"
})

设置和获取背景

import {GGContext} from "@grest-ts/context"

new GGContext("request").run(() => {

    // Set context value
    RequestIdKey.set("req-123")

    // Get context value (returns undefined if not set, or defaultValue if defined)
    const requestId = RequestIdKey.get()

    // Check if value exists
    if (RequestIdKey.has()) { ...
    }

    // Assert value exists (throws if not set)
    const id = RequestIdKey.assert()

    // Delete value
    RequestIdKey.delete()

})

使用 GGContextStore 静态助手

import {GGContextStore} from "@grest-ts/context"

// Check if context exists
if (GGContextStore.hasContext()) {
    const ctx = GGContextStore.getContext()
}

// Safe access (returns undefined if no context)
const ctx = GGContextStore.tryGetContext()

// Branch from current context (child inherits parent values)
const childCtx = GGContextStore.branch("child-request")

分支

儿童背景继承了父母的价值观,但可以超越:

const parentCtx = new GGContext("parent")
parentCtx.run(() => {
    RequestIdKey.set("req-123")

    const childCtx = GGContextStore.branch("child")
    childCtx.run(() => {
        RequestIdKey.get()  // "req-123" - inherited from parent
        RequestIdKey.set("req-456")  // Override in child
        RequestIdKey.get()  // "req-456"
    })

    RequestIdKey.get()  // "req-123" - parent unchanged
})

Async 上下文帮助工具

保留跨自动同步边界的上下文 :

GGContextStore.setTimeout(() => {
    // Context is preserved here
    RequestIdKey.get()
}, 1000)

GGContextStore.setInterval(() => { ...
}, 5000)
GGContextStore.setImmediate(() => { ...
})

版本与发布记录

@grest-ts/context 共发布 84 个版本,首次发布于 2026/02/24;过去 12 个月发布了 84 个版本。

版本发布日期距今
0.0.101latest2026/11/0214 天前
0.0.1002026/10/3017 天前
0.0.992026/10/3018 天前
0.0.982026/10/2820 天前
0.0.972026/10/2720 天前
0.0.962026/10/2721 天前

关于 @grest-ts/context 的常见问题

@grest-ts/context 是什么?

等级化合成上下文

如何安装 @grest-ts/context?

在项目目录运行 npm install @grest-ts/context,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@grest-ts/common(0.0.101)、@grest-ts/schema(0.0.101)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@grest-ts/context 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@grest-ts/context 支持 ESM 还是 CommonJS?

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

@grest-ts/context 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@grest-ts/context 可以商用吗?

@grest-ts/context 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@grest-ts/context 的下载量有多少?

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

@grest-ts/context 还在维护吗?

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