Module testing

Index

Classes

Result

Interfaces

TestDefinition

Type aliases

TestFunction

Functions

Type aliases

TestFunction

TestFunction: () => void

Type declaration

- (): void
- 测试函数。
  
  Returns void

Functions

after

after(name: string, fn: TestFunction): void

设置在所有用例执行完毕以后执行的函数，一般用于环境清理。
example
```
import * as test from 'testing';

test.after('name', () => {
  // 所有用例执行完毕以后执行的函数。
});
```
Parameters
- name: string
  
  名称
- fn: TestFunction
  
  待执行函数
Returns void

afterEach

afterEach(name: string, fn: TestFunction): void

设置在每个测试用例后执行的函数，一般用于用例数据清理等场景。
example
```
import * as test from 'testing';

test.afterEach('name', () => {
  // 每个用例执行后执行的代码。
});
```
Parameters
- name: string
  
  名称
- fn: TestFunction
  
  待执行函数
Returns void

before

before(name: string, fn: TestFunction): void

设置在所有用例执行前执行的函数，一般用于环境初始化等场景。
example
```
import * as test from 'testing';

test.before('name', () => {
  // 所有用例执行前执行的代码。
});
```
Parameters
- name: string
  
  名称
- fn: TestFunction
  
  待执行函数
Returns void

beforeEach

beforeEach(name: string, fn: TestFunction): void

设置在每个用例执行前执行的函数，一般用于单用例数据准备等场景。
example
```
import * as test from 'testing';

test.beforeEach('name', () => {
  // 每个用例执行前执行的代码。
});
```
Parameters
- name: string
  
  名称
- fn: TestFunction
  
  待执行函数
Returns void

runSuite

runSuite(): Result[]

执行测试，该函数会被引擎自动调用，一般情况下无需手动调用。

Returns Result[]

测试结果

setFilter

setFilter(s: string): void

设置需要执行的函数，满足给定的名称才会被执行。
example
```
import * as test from 'testing';

test.setFilter('string'); // 仅执行名称带有 string 的测试用例
```
Parameters
- s: string
  
  用字符串表达的正则表达式
Returns void

test

test(name: string, fn: TestFunction): void

添加一个测试用例。
example
```
import * as test from 'testing';

test.test('name', () => {
  // 测试用例的代码。
});
```
Parameters
- name: string
  
  测试用例的名字
- fn: TestFunction
  
  测试用例函数
Returns void