# @getlarge/nestjs-tools-async-local-storage 中文文档

规范地址：https://npmcn.com/package/%40getlarge/nestjs-tools-async-local-storage/

版本：0\.3\.1
npm 元数据更新时间：2025-01-31T09:56:41.987Z
中文译文更新时间：2026-11-16T06:18:35.318Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40getlarge/nestjs-tools-async-local-storage
原文对照：https://npmcn.com/package/%40getlarge/nestjs-tools-async-local-storage/?lang=original
项目主页：https://github.com/getlarge/nestjs-tools/tree/main/packages/async-local-storage

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：36.8 kB，27 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@nestjs/common ^10 \|\| ^11，@nestjs/core ^10 \|\| ^11，rxjs ^7\.8\.0
- 首次发布：2024-04-16T20:35:43.382Z
- 最新版本发布：2025-01-31T09:56:41.820Z
- 近 30 天下载量：5407（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

节点 Async Hooks 包装以存储请求上下文

## 安装

```sh
npm install @getlarge/nestjs-tools-async-local-storage
```

也可以使用：`pnpm add @getlarge/nestjs-tools-async-local-storage`、`yarn add @getlarge/nestjs-tools-async-local-storage`、`bun add @getlarge/nestjs-tools-async-local-storage`

## README

# Async 本地存储

[![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-async-local-storage.svg?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-async-local-storage)

## 安装

```bash
npm install --save @getlarge/nestjs-tools-async-local-storage
```

## 使用量

```ts
import assert from 'assert';
import { AsyncLocalStorage } from 'async_hooks';

// to provide type safety for the store map
declare module '@getlarge/nestjs-tools-async-local-storage' {
  interface RequestContext {
    type?: string;
  }
  interface ContextStoreProperties {
    id: number;
    username: string;
    profilePicture: string;
    name: string;
  }
}

import { AsyncLocalStorageService } from '@getlarge/nestjs-tools-async-local-storage';

const service = new AsyncLocalStorageService(new AsyncLocalStorage());

assert.throws(() => service.store.set('id', 1), new TypeError("Cannot read properties of undefined (reading 'set')"));
assert.throws(() => service.set('id', 1), new Error("Store is not initialized. Call 'enterWith' or 'run' first."));

service.enterWith(new Map());

// access store map directly
service.store.set('id', 1);
const id = service.store.get('id');
assert(typeof id === 'number');

// access store map via service which extends Map
service.set('username', 'john');
assert(typeof service.get('username') === 'string');

service.requestContext = { type: 'http' };
const requestContext = service.requestContext;
assert(typeof requestContext.type === 'string');

service.delete('username');
```

## 常见问题

### @getlarge/nestjs-tools-async-local-storage 是什么？

节点 Async Hooks 包装以存储请求上下文

### 如何安装 @getlarge/nestjs-tools-async-local-storage？

在项目目录运行 npm install @getlarge/nestjs-tools-async-local-storage，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/common（^10 \|\| ^11）、@nestjs/core（^10 \|\| ^11）、rxjs（^7\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @getlarge/nestjs-tools-async-local-storage 支持 TypeScript 吗？

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

### @getlarge/nestjs-tools-async-local-storage 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @getlarge/nestjs-tools-async-local-storage 可以商用吗？

@getlarge/nestjs-tools-async-local-storage 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @getlarge/nestjs-tools-async-local-storage 的下载量有多少？

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

### @getlarge/nestjs-tools-async-local-storage 还在维护吗？

最新版本 0\.3\.1 发布于 2025/01/31（1\.8 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/04/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

