lib/errors - 文档 - Mocha 中文

包含错误代码、用于创建可抛出错误对象的工厂函数，
以及警告/弃用函数。

源代码

errors.js, 第 5 行

Namespaces

constants

方法

(静态) createFatalError(message) → {Error}

源代码

errors.js, 第 320 行

创建一个错误对象，当发生不可恢复的错误时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。

返回值

详细说明错误条件的实例

类型: Error

(静态) createForbiddenExclusivityError(mocha) → {Error}

源代码

errors.js, 第 443 行

创建一个错误对象，当使用 .only() 时抛出，
--forbid-only.

Parameters

名称	类型	描述
`mocha`	Mocha	Mocha 实例

返回值

错误代码为 constants.FORBIDDEN_EXCLUSIVITY 的错误

类型: Error

(静态) createInvalidArgumentTypeError(message, argument, expected) → {Error}

源代码

errors.js, 第 267 行

创建一个错误对象，当参数没有使用支持的类型时抛出

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`argument`	string	参数名称。
`expected`	string	预期参数数据类型。

返回值

详细说明错误条件的实例

类型: Error

(静态) createInvalidArgumentValueError(message, argument, value, reasonopt) → {Error}

源代码

errors.js, 第 287 行

创建一个错误对象，当参数没有使用支持的值时抛出

Parameters

名称	类型	属性	描述
`message`	string		要显示的错误消息。
`argument`	string		参数名称。
`value`	string		参数值。
`reason`	string	<可选>	为什么值无效。

返回值

详细说明错误条件的实例

类型: Error

(静态) createInvalidExceptionError(message) → {Error}

源代码

errors.js, 第 304 行

创建一个错误对象，当捕获到异常，但 Error 为假值或未定义时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。

返回值

详细说明错误条件的实例

类型: Error

(静态) createInvalidInterfaceError(message, ui) → {Error}

源代码

errors.js, 第 222 行

创建一个错误对象，当选项中指定的界面未找到时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`ui`	string	用户指定的界面值。

返回值

详细说明错误条件的实例

类型: Error

(静态) createInvalidLegacyPluginError(message, pluginType, pluginIdopt) → {Error}

源代码

errors.js, 第 338 行

根据插件类型动态创建一个插件类型特定的错误

Parameters

名称	类型	属性	描述
`message`	string		错误消息
`pluginType`	"reporter" \| "ui"		插件类型。未来：根据需要扩展
`pluginId`	string	<可选>	插件的名称/路径，如果有的话

抛出

当 pluginType 未知时

返回值

类型: Error

(静态) createInvalidPluginDefinitionError(msg, pluginDefopt) → {Error}

源代码

errors.js, 第 461 行

创建一个错误对象，当插件定义无效时抛出

Parameters

名称	类型	属性	描述
`msg`	string		错误消息
`pluginDef`	PluginDefinition	<可选>	有问题的插件定义

返回值

错误代码为 constants.INVALID_PLUGIN_DEFINITION 的错误

类型: Error

(静态) createInvalidPluginError(message, pluginType, pluginIdopt) → {Error}

源代码

errors.js, 第 360 行

已弃用

已弃用。使用 createInvalidLegacyPluginError 代替根据插件类型动态创建一个插件类型特定的错误

Parameters

名称	类型	属性	描述
`message`	string		错误消息
`pluginType`	"reporter" \| "interface"		插件类型。未来：根据需要扩展
`pluginId`	string	<可选>	插件的名称/路径，如果有的话

抛出

当 pluginType 未知时

返回值

类型: Error

(静态) createInvalidPluginImplementationError(msg, optsopt) → {Error}

源代码

errors.js, 第 478 行

创建一个错误对象，当插件实现（用户代码）无效时抛出

Parameters

名称类型属性描述

msg

string

错误消息

opts

Object

<可选>

插件定义和用户提供的实现

属性

名称	类型	属性	描述
`pluginDef`	PluginDefinition	<可选>	插件定义
`pluginImpl`	*	<可选>	插件实现（用户提供）

返回值

错误代码为 constants.INVALID_PLUGIN_DEFINITION 的错误

类型: Error

(静态) createMissingArgumentError(message, argument, expected) → {Error}

源代码

errors.js, 第 253 行

创建一个错误对象，当参数缺失时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`argument`	string	参数名称。
`expected`	string	预期参数数据类型。

返回值

详细说明错误条件的实例

类型: Error

(静态) createMochaInstanceAlreadyDisposedError(message, cleanReferencesAfterRun, instance)

源代码

errors.js, 第 372 行

创建一个错误对象，当 mocha 对象的 run 方法在它已经被释放后执行时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`cleanReferencesAfterRun`	boolean	`cleanReferencesAfterRun` 的值
`instance`	Mocha	抛出此错误的 mocha 实例

(静态) createMochaInstanceAlreadyRunningError(message)

源代码

errors.js, 第 390 行

创建一个错误对象，当 mocha 对象的 run 方法在测试运行过程中被调用时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。

(静态) createMultipleDoneError(runnable, originalErropt) → {Error}

源代码

errors.js, 第 406 行

创建一个错误对象，当在测试中多次调用 done() 时抛出

Parameters

名称	类型	属性	描述
`runnable`	Runnable		原始可运行对象
`originalErr`	Error	<可选>	原始错误，如果有的话

返回值

详细说明错误条件的实例

类型: Error

(静态) createNoFilesMatchPatternError(message, pattern) → {Error}

源代码

errors.js, 第 191 行

创建一个错误对象，当使用指定的模式找不到要测试的文件时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`pattern`	string	用户指定的参数值。

返回值

详细说明错误条件的实例

类型: Error

(静态) createTimeoutError(msg, timeoutopt, fileopt) → {MochaTimeoutError}

源代码

errors.js, 第 497 行

创建一个错误对象，当可运行对象超过其允许的运行时间时抛出。

Parameters

名称	类型	属性	描述
`msg`	string		错误消息
`timeout`	number	<可选>	以毫秒为单位的超时时间
`file`	string	<可选>	文件，如果有的话

返回值

类型: MochaTimeoutError

(静态) createUnparsableFileError(message, filename) → {Error}

源代码

errors.js, 第 513 行

创建一个错误对象，当文件无法解析时抛出

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`filename`	string	文件名

返回值

错误代码为 constants.UNPARSABLE_FILE 的错误

类型: Error

(静态) createUnsupportedError(message) → {Error}

源代码

errors.js, 第 237 行

创建一个错误对象，当行为、选项或参数不受支持时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。

返回值

详细说明错误条件的实例

类型: Error

(静态) isMochaError(err) → {boolean}

源代码

errors.js, 第 527 行

如果错误来自 Mocha，则返回 true。
可能会出现假阴性，但不会出现假阳性。

Parameters

名称	类型	描述
`err`	*	错误，或任何东西

返回值

类型: boolean

(内部) createInvalidReporterError(message, reporter) → {Error}

源代码

errors.js, 第 206 行

创建一个错误对象，当选项中指定的 Reporter 未找到时抛出。

Parameters

名称	类型	描述
`message`	string	要显示的错误消息。
`reporter`	string	用户指定的 Reporter 值。

返回值

详细说明错误条件的实例

类型: Error

类型定义

MochaTimeoutError

源代码

errors.js, 第 556 行

属性

名称	类型	属性	描述
`code`	constants.TIMEOUT		错误代码
`timeout`	number	<可为空>	以毫秒为单位的超时时间
`file`	string	<可为空>	文件路径，如果有的话

当 Runnable 超时时抛出的错误

类型

Error