This represents the available reporter callback for an object passed to Env#addReporter.
- Source:
- See:
-
- custom_reporter
Methods
jasmineDone(suiteInfo, doneopt)
When the entire suite has finished execution `jasmineDone` is called
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
suiteInfo |
JasmineDoneInfo | Information about the full Jasmine suite that just finished running. | |
done |
function |
<optional> |
Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. |
- Source:
- See:
-
- async
Returns:
Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion.
jasmineStarted(suiteInfo, doneopt)
`jasmineStarted` is called after all of the specs have been loaded, but just before execution starts.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
suiteInfo |
JasmineStartedInfo | Information about the full Jasmine suite that is being run | |
done |
function |
<optional> |
Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. |
- Source:
- See:
-
- async
Returns:
Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion.
specDone(result, doneopt)
`specDone` is invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
While jasmine doesn't require any specific functions, not defining a `specDone` will make it impossible for a reporter to know when a spec has failed.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
result |
SpecResult | ||
done |
function |
<optional> |
Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. |
- Source:
- See:
-
- async
Returns:
Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion.
specStarted(result, doneopt)
`specStarted` is invoked when an `it` starts to run (including associated `beforeEach` functions)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
result |
SpecResult | Information about the individual it being run | |
done |
function |
<optional> |
Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. |
- Source:
- See:
-
- async
Returns:
Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion.
suiteDone(result, doneopt)
`suiteDone` is invoked when all of the child specs and suites for a given suite have been run
While jasmine doesn't require any specific functions, not defining a `suiteDone` will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
result |
SuiteResult | ||
done |
function |
<optional> |
Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. |
- Source:
- See:
-
- async
Returns:
Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion.
suiteStarted(result, doneopt)
`suiteStarted` is invoked when a `describe` starts to run
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
result |
SuiteResult | Information about the individual describe being run | |
done |
function |
<optional> |
Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. |
- Source:
- See:
-
- async
Returns:
Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion.