Type Definitions
FileCollectionResponse
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
files | Array:.<string:> | A list of files to test |
unmatchedFiles | Array:.<UnmatchedFile:> | A list of unmatched files derived from the file arguments passed in. |
Response object containing a list of files to test and unmatched files.
Type:
- Object
MochaGlobalFixture() → {void|Promise:.<void:>}
A function that's invoked once which is either sync or async.
Can be a "teardown" or "setup". These will all share the same context.
Returns:
MochaRootHookFunction() → {MochaRootHookObject|Promise:.<MochaRootHookObject:>}
An function that returns a MochaRootHookObject, either sync or async.
Returns:
- Type
- MochaRootHookObject | Promise:.<MochaRootHookObject:>
MochaRootHookObject
Properties:
An alternative way to define root hooks that works with parallel runs.
Type:
- Object
PluginDefinition
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
exportName | string | Named export to use | |
optionName | string | <optional> | Option name for Mocha constructor (use |
validate | PluginValidator | <optional> | Validator function |
finalize | PluginFinalizer | <optional> | Finalizer/aggregator function |
An object making up all necessary parts of a plugin loader and aggregator
Type:
- Object
PluginFinalizer(impls) → {Promise:.<*:>|*}
A function to finalize plugins impls of a particular ilk
Parameters:
| Name | Type | Description |
|---|---|---|
impls | Array:.<*:> | User-supplied implementations |
Returns:
PluginLoaderOptions
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
pluginDefs | Array:.<PluginDefinition:> | <optional> | Plugin definitions |
ignore | Array:.<string:> | <optional> | A list of plugins to ignore when loading |
Options for PluginLoader
Type:
- Object
PluginValidator(value) → {void}
A (sync) function to assert a user-supplied plugin implementation is valid.
Defined in a PluginDefinition.
This:
Parameters:
| Name | Type | Description |
|---|---|---|
value | * | Value to check |
Returns:
- Type
- void
UnmatchedFile
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
absolutePath | string | A list of unmatched files derived from the file arguments passed in. |
pattern | string | A list of unmatched files derived from the file arguments passed in. |
Diagnostic object containing unmatched files
Type:
- Object