Constructor
new Jasmine(options)
Parameters:
| Name | Type | Description |
|---|---|---|
options |
JasmineOptions | undefined |
Example
const Jasmine = require('jasmine');
const jasmine = new Jasmine();Members
(readonly) env :Env
The Jasmine environment.
Type:
- Env
- See:
Methods
addMatchers(matchers)
Add custom matchers for the current scope of specs.
Note: This is only callable from within a beforeEach, it, or beforeAll.
Parameters:
| Name | Type | Description |
|---|---|---|
matchers |
Object | Keys from this object will be the new matcher names. |
- See:
addReporter(reporter)
Add a custom reporter to the Jasmine environment.
Parameters:
| Name | Type | Description |
|---|---|---|
reporter |
Reporter | The reporter to add |
- See:
addSpecFile(filePath)
Adds a spec file to the list that will be loaded when the suite is executed.
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
string | The path to the file to be loaded. |
clearReporters()
Clears all registered reporters.
configureDefaultReporter(options)
Configures the default reporter that is installed if no other reporter is specified.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
ConsoleReporterOptions |
coreVersion() → {string}
Returns:
The version of jasmine-core in use
- Type
- string
execute(filesopt, filterStringopt) → {Promise.<void>}
Runs the test suite.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
files |
Array.<string> |
<optional> |
Spec files to run instead of the previously configured set |
filterString |
string |
<optional> |
Regex used to filter specs. If specified, only specs with matching full names will be run. |
Returns:
Promise that is resolved when the suite completes.
- Type
- Promise.<void>
loadConfig(config)
Loads configuration from the specified object.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Configuration |
loadConfigFile(configFilePathopt)
Loads configuration from the specified file. The file can be a JSON file or any JS file that's loadable via require and provides a Jasmine config as its default export.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
configFilePath |
string |
<optional> |
spec/support/jasmine.json |
onComplete(onCompleteCallback)
Registers a callback that will be called when execution finishes.
Note: Only one callback can be registered. The callback will be called after the suite has completed and the results have been finalized, but not necessarily before all of Jasmine's cleanup has finished.
Parameters:
| Name | Type | Description |
|---|---|---|
onCompleteCallback |
function |
provideFallbackReporter(reporter)
Provide a fallback reporter if no other reporters have been specified.
Parameters:
| Name | Type | Description |
|---|---|---|
reporter |
The fallback reporter |
- See:
randomizeTests(value)
Sets whether to randomize the order of specs.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether to randomize |
seed(seed)
Sets the random seed.
Parameters:
| Name | Type | Description |
|---|---|---|
seed |
number | The random seed |
showColors(value)
Sets whether to show colors in the console reporter.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether to show colors |
stopOnSpecFailure(value)
Sets whether to stop execution of the suite after the first spec failure.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether to stop execution of the suite after the first spec failure |
stopSpecOnExpectationFailure(value)
Sets whether to cause specs to only have one expectation failure.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether to cause specs to only have one expectation failure |
