@golevelup/nestjs-testing

中文文档
0.1.2发布于 2019/11/14MITTypeScriptCommonJS零依赖近 30 天下载 8.4万

可重新使用的用户帮助升级 NestJS 测试

此软件包已被标记为弃用

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

中文使用文档
文档目录6 节
  1. 说明
  2. 动机
  3. 边注
  4. 使用量
  5. 安装
  6. 创建模拟

@golevelup/nestjs-测试

version downloads license

说明

测试用品 网点JS 应用程序更容易。 目前支持杰斯特.

动机

你曾经遇到过一个你想要嘲笑的类型,但嘲弄整个对象似乎令人生畏,谁知道对象有多少子属性,如果这些子属性有子属性. 名单继续列出可能出现的问题。 输入 @golevelup/nestjs-testing是因为 createMock 函数。 此函数将为您创建一个模拟对象, 所有子属性被模拟为 jest.fn() 除非另有规定,否则以后可以容易地嘲笑,但以后可以更多地嘲笑.

边注

这个软件包和工具功能来源于帮助这些单位测试诸如 警卫, (中文(简体) ), 截取器,以及 过滤器,在NestJS中;然而,鉴于软件包的动态性质 createMock 公用功能可以处理这么多 不只是NestJS内部的东西。 基本上,如果它有一个接口, @golevelup/nestjs-testing 能够嘲笑它!

使用量

举个例子,我们可以证明它和NestJS的关系 执行语句 伸展巢穴的 参数。 。 。 .

安装

相当标准的安装,没什么太疯狂的

npm i @golevelup/nestjs-testing

或者说

yarn @golevelup/nestjs-testing

创建模拟

乐从此起. 作为注意,这个功能 已经 要求您使用 Typescript, 因为它利用一些高级 Typescript 特性在引擎盖下, 例如 Proxies。 。 。 .

  1. 导入 createMock 函数进入测试类
  2. 创建变量并将其设置为 createMock 函数 加号 其通用类型输入
  3. 使用模拟器,卢克.

示例

import { createMock } from '@golevelup/nestjs-testing';
import { ExecutionContext } from '@nestjs/common';

describe('Mocked Execution Context', () => {
  it('should have a fully mocked Execution Context', () => {
    const mockExecutionContext = createMock<ExecutionContext>();
    expect(mockExecutionContext.switchToHttp()).toBeDefined();
  });
});

就这么简单,最简单的模拟可以快速和容易地制作! "大交易"你说呢? 以这样的单一地产制作出"模拟"就容易了?. 好吧,只是看着这个:

import { createMock } from '@golevelup/nestjs-testing';
import { ExecutionContext } from '@nestjs/common';

describe('Mocked Execution Context', () => {
  it('should have a fully mocked Execution Context', () => {
    const mockExecutionContext = createMock<ExecutionContext>();
    expect(mockExecutionContext.switchToHttp().getRequest()).toBeDefined();
    expect(mockExecutionContext.switchToRPC().getContext()).toBeDefined();
    expect(mockExecutionContext.switchToWs().getClient()).toBeDefined();
  });
});

你怎么样? 不,还是没有印象? 好了,该拿出大炮了.

import { createMock } from '@golevelup/nestjs-testing';
import { ExecutionContext } from '@nestjs/common';

describe('Mocked Execution Context', () => {
  it('should have a fully mocked Execution Context', () => {
    const mockExecutionContext = createMock<ExecutionContext>({
      switchToHttp: () => ({
        getRequest: () =({
          headers: {
            authorization: 'auth'
          }
        })
      })
    });
    mockExecutionContext.switchToHttp().getResponse.mockReturnValue({data: 'res return data'});
    expect(mockExecutionContext.switchToHttp().getRequest()).toEqual({
      headers: {
        authorization: 'auth'
      }
    });
    expect(mockExecutionContext.switchToHttp().getResponse()).toEqual({
      data: 'res return data'
    });
    expect(mockExecutionContext.switchToHttp).toBeCalledTimes(3);
    expect(mockExecutionContext.switchToRPC().getContext()).toBeDefined();
    expect(mockExecutionContext.switchToWs().getClient()).toBeDefined();
  });
});

说明:请注意,在提供自己的模拟时,如果您断言您称母模拟函数的次数,则该数字将等于函数在您的 expects 加号 用于设置模拟的函数次数。 在上述情况下,我们不得不打电话 switchToHttp() 一次设置模拟器 getResponse() 和两次 expect 所以总共打了三次电话.

上述案例表明 createMock 工具可以接受用户提供的值以及返回 类型安全 这些模型可以很容易地被锁起来并根据需要加以修改.

关于可以做些什么的几个例子 模拟. spec 文件有一些非常酷的例子, 能够很好地显示这个工具的可用性 .

版本与发布记录

@golevelup/nestjs-testing 共发布 3 个版本,首次发布于 2019/11/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.2latest2019/11/147 年前
0.1.12019/11/107 年前
0.1.02019/11/097 年前

关于 @golevelup/nestjs-testing 的常见问题

@golevelup/nestjs-testing 是什么?

可重新使用的用户帮助升级 NestJS 测试注意:该包已被作者标记为弃用——Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

如何安装 @golevelup/nestjs-testing?

在项目目录运行 npm install @golevelup/nestjs-testing,或使用 pnpm add / yarn add / bun add。

@golevelup/nestjs-testing 支持 TypeScript 吗?

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

@golevelup/nestjs-testing 支持 ESM 还是 CommonJS?

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

@golevelup/nestjs-testing 可以商用吗?

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

@golevelup/nestjs-testing 的下载量有多少?

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

@golevelup/nestjs-testing 还在维护吗?

最新版本 0.1.2 发布于 2019/11/14(7 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/11/09。作者已将其标记为弃用,新项目建议寻找替代方案。