Constructor
new Jasmine(options)
Parameters:
| Name | Type | Description |
|---|---|---|
options |
JasmineOptions | undefined |
Example
const Jasmine = require('jasmine');
const jasmine = new Jasmine();Extends
Members
(readonly) env :Env
The Jasmine environment.
Type:
- Env
- See:
exitOnCompletion :boolean
Whether to cause the Node process to exit when the suite finishes executing.
Type:
- boolean
- Overrides:
- Default Value:
- true
Methods
addHelperFile(filePath)
Adds a helper 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. |
- Inherited From:
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:
addMatchingHelperFiles(patterns)
Adds files that match the specified patterns to the list of helper files.
Parameters:
| Name | Type | Description |
|---|---|---|
patterns |
Array.<string> | An array of helper file paths or globs that match helper files. Each path or glob will be evaluated relative to the spec directory. |
- Inherited From:
addMatchingSpecFiles(patterns)
Adds files that match the specified patterns to the list of spec files.
Parameters:
| Name | Type | Description |
|---|---|---|
patterns |
Array.<string> | An array of spec file paths or globs that match spec files. Each path or glob will be evaluated relative to the spec directory. |
- Inherited From:
addReporter(reporter)
Add a custom reporter to the Jasmine environment.
Parameters:
| Name | Type | Description |
|---|---|---|
reporter |
Reporter | The reporter to add |
- Overrides:
- 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. |
- Inherited From:
alwaysListPendingSpecs(value)
Sets whether the console reporter should list pending specs even when there are failures.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
- Inherited From:
clearReporters()
Clears all registered reporters.
- Overrides:
configureDefaultReporter(options)
Configures the default reporter that is installed if no other reporter is specified.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
ConsoleReporterOptions |
- Inherited From:
coreVersion() → {string}
Returns:
The version of jasmine-core in use
- Type
- string
(async) execute(filesopt, filterStringopt) → {Promise.<JasmineDoneInfo>}
Runs the test suite.
Note: Set exitOnCompletion to false if you
intend to use the returned promise. Otherwise, the Node process will
ordinarily exit before the promise is settled.
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.<JasmineDoneInfo>
loadConfig(config)
Loads configuration from the specified object.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Configuration |
- Inherited From:
loadConfigFile(configFilePathopt)
Loads configuration from the specified file. The file can be a JSON file or any JS file that's loadable as a module and provides a Jasmine config as its default export.
The config file will be loaded via dynamic import() unless this Jasmine instance has already been configured with {jsLoader: 'require'}. Dynamic import() supports ES modules as well as nearly all CommonJS modules.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
configFilePath |
string |
<optional> |
spec/support/jasmine.json |
- Inherited From:
Returns:
Promise
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 |
- Inherited From:
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 |
verbose(value)
Sets whether to run in verbose mode, which prints information that may be useful for debugging configuration problems.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether to run in verbose mode |
- Inherited From:
