describe([name][, options][, fn])
name
<string> 套件名称,报告测试结果时显示。 默认值: Thename
fn
的属性,如果fn
没有名称,则为'<anonymous>'
。options
<Object> 套件的配置选项。 支持与test([name][, options][, fn])
相同的选项。fn
<Function> | <AsyncFunction> 套件下的函数声明所有子测试和子套件。 此函数的第一个参数是SuiteContext
对象。 默认值: 无操作的函数。- 返回:
undefined
。
从 node:test
模块导入的 describe()
函数。
每次调用此函数都会在 TAP 输出中创建一个子测试和一个测试点。
调用顶级 describe
函数后,所有顶级测试和套件都将执行。
name
<string> The name of the suite, which is displayed when reporting test results. Default: Thename
property offn
, or'<anonymous>'
iffn
does not have a name.options
<Object> Configuration options for the suite. supports the same options astest([name][, options][, fn])
.fn
<Function> | <AsyncFunction> The function under suite declaring all subtests and subsuites. The first argument to this function is aSuiteContext
object. Default: A no-op function.- Returns:
undefined
.
The describe()
function imported from the node:test
module. Each
invocation of this function results in the creation of a Subtest
and a test point in the TAP output.
After invocation of top level describe
functions,
all top level tests and suites will execute.