Chai 提供的 Should API 的使用详解

在前端开发中，测试是一个非常重要的环节，而 Chai 是一个常用的测试库。其中，Chai 的 Should API 可以让我们更加方便地进行断言。本文将详细介绍 Should API 的使用方法，以及一些注意事项。

Should API 的使用

首先，我们需要在项目中引入 Chai 库：

<script src="https://cdn.jsdelivr.net/npm/chai@4.3.4/chai.min.js"></script>

然后，我们就可以使用 Should API 进行断言了。Should API 主要有以下几个方法：

• should
• not

should

should 方法是 Should API 中最常用的方法。它可以让我们非常方便地进行断言。具体使用方法如下：

const foo = 'bar';
foo.should.equal('bar');

上面的代码中，我们使用 should 方法进行断言，判断 foo 的值是否等于 'bar'。如果相等，则断言通过。

should 方法还可以与其他 Chai 断言方法一起使用。例如：

const foo = [1, 2, 3];
foo.should.be.an('array').that.includes(2);

上面的代码中，我们首先使用 should 方法断言 foo 是一个数组，然后使用 Chai 的 includes 方法判断数组中是否包含 2。如果包含，则断言通过。

not

not 方法可以让我们对断言结果取反。具体使用方法如下：

const foo = 'bar';
foo.should.not.equal('baz');

上面的代码中，我们使用 not 方法对断言结果取反，判断 foo 的值是否不等于 'baz'。如果不相等，则断言通过。

not 方法也可以与其他 Chai 断言方法一起使用。例如：

const foo = [1, 2, 3];
foo.should.be.an('array').that.does.not.include(4);

上面的代码中，我们首先使用 should 方法断言 foo 是一个数组，然后使用 Chai 的 include 方法判断数组中是否包含 4，最后使用 not 方法对断言结果取反。如果不包含，则断言通过。

注意事项

在使用 Should API 进行断言时，需要注意以下几点：

• 在使用 should 方法进行断言时，需要先对变量进行赋值。例如：

  const foo = 'bar';
  foo.should.equal('bar');

• 在使用 not 方法进行断言时，需要在 should 方法之后使用。例如：

  const foo = 'bar';
  foo.should.not.equal('baz');

• 在使用 should 方法进行断言时，需要注意链式调用的顺序。例如：

  const foo = [1, 2, 3];
  foo.should.be.an('array').that.includes(2);

  上面的代码中，我们首先使用 should 方法断言 foo 是一个数组，然后使用 Chai 的 includes 方法判断数组中是否包含 2。如果我们把链式调用的顺序颠倒，代码将会报错。

示例代码

最后，我们提供一个完整的示例代码，供大家参考：

// www.javascriptcn.com code example
const chai = require('chai');
const should = chai.should();

describe('Should API', function() {
  it('should equal', function() {
    const foo = 'bar';
    foo.should.equal('bar');
  });

  it('should not equal', function() {
    const foo = 'bar';
    foo.should.not.equal('baz');
  });

  it('should include', function() {
    const foo = [1, 2, 3];
    foo.should.be.an('array').that.includes(2);
  });

  it('should not include', function() {
    const foo = [1, 2, 3];
    foo.should.be.an('array').that.does.not.include(4);
  });
});

上面的代码中，我们使用 Mocha 框架进行测试，并使用 Chai 库进行断言。其中，Should API 的使用方法与上文相同。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d0fffca941bf71342298aa