@automapper/nestjs

中文文档
9.0.2发布于 2026/07/17MITTypeScriptES Module零依赖近 30 天下载 26.4万

自动Mapper 类型脚本 NestJS 集成

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 拦截器和管道
  4. 日志

@ automapper/nestjs (英语)

这是一个 NestJS 模块集成 @automapper 与雀巢JS.

安装

npm i @automapper/nestjs

或带有 yarn数字 :

yarn add @automapper/nestjs

peerDependencies

@automapper/nestjs 取决于 @automapper/core

npm i @automapper/core

或带有 yarn数字 :

yarn add @automapper/core

使用量

打电话 AutomapperModule.forRoot() ,并提供一些选项来初始化 Mapper 对象.

// Single Mapper
@Module({
    imports: [
        AutomapperModule.forRoot({
            strategyInitializer: classes(),
        }),
    ],
})
export class AppModule {}

// Multiple Mappers
@Module({
    imports: [
        AutomapperModule.forRoot(
            [
                {
                    name: 'classes',
                    strategyInitializer: classes(),
                },
                {
                    name: 'pojos',
                    strategyInitializer: pojos(),
                },
            ],
            {
                /*  globalErrorHandler: ErrorHandler */
                /*  globalNamingConventions: NamingConvention | {source, destination} */
            }
        ),
    ],
})
export class AppModule {}

AutomapperModule 是一个 Global 模块 Mapper 对象被初始化,它们在整个应用程序中都可以使用.

拦截器和管道

MapInterceptor 地图路由处理器响应,同时 MapPipe 收到的地图 @Body() 或者说 @Query() 数值。 两者都支持同步和同步地绘制地图,包括承诺返回的成员解析器和绘图回调. 通过Nest的正常例外处理来传播绘图错误.

日志

通过全局自动Mapper日志 AutoMapperLogger 从 @automapper/core。 。 。 . 如果您使用结构化的日志,请尽早在您的 应用程序条目 :

import { AutoMapperLogger } from '@automapper/core';

AutoMapperLogger.configure({
    warn: (message, ...params) => logger.warn(message, ...params),
    error: (message, ...params) => logger.error(message, ...params),
});

在装饰器运行时, 在运行前, 一些 AutoMapper 日志可能发生 AutomapperModule.forRoot() 或者说 forRootAsync() 执行。 配置 AutoMapperLogger 如果日志需要,在导入已装饰的模型类之前 使用您的日志.

用于映射器特定的运行时间错误处理, 使用 errorHandler 或者说 globalErrorHandler。 。 。 . AutomapperModule 不接受日志选项.

有关这个的更多信息,请在 文档网站

版本与发布记录

@automapper/nestjs 共发布 145 个版本,首次发布于 2021/01/04;过去 12 个月发布了 4 个版本。

版本发布日期距今
9.0.2latest2026/07/173 个月前
9.0.12026/07/163 个月前
9.0.0-alpha.1beta2026/06/244 个月前
9.0.0-alpha.02026/06/244 个月前
8.8.12024/01/232 年前
8.8.02024/01/222 年前

关于 @automapper/nestjs 的常见问题

@automapper/nestjs 是什么?

自动Mapper 类型脚本 NestJS 集成

如何安装 @automapper/nestjs?

在项目目录运行 npm install @automapper/nestjs,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@automapper/core(^9.0.2)、@nestjs/common(^10.0.0 || ^11.0.0)、@nestjs/core(^10.0.0 || ^11.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@automapper/nestjs 支持 TypeScript 吗?

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

@automapper/nestjs 支持 ESM 还是 CommonJS?

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

@automapper/nestjs 需要什么版本的 Node.js?

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

@automapper/nestjs 可以商用吗?

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

@automapper/nestjs 的下载量有多少?

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

@automapper/nestjs 还在维护吗?

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