Members
AMPReportingService
Gets the instance of the AMP reporting service associated with this instance of Continuum.
Please consult our support documentation for more information on how to report to AMP.
- Source:
includePotentialAccessibilityConcerns
Defines whether or not accessibility concerns that require manual review are included in any of Continuum's test results.
This functionality is disabled by default, but it can be enabled via Continuum#setIncludePotentialAccessibilityConcerns.
If enabled, any accessibility concerns that require manual review will have AccessibilityConcern#needsReview return true.
- Source:
LevelAccessPlatformReportingService
Gets the instance of the Level Access Platform reporting service associated with this instance of Continuum.
Please consult our support documentation for more information on how to report to the Level Access Platform.
- Source:
Methods
(static) getRandomUUID() → {String}
- Source:
Returns:
- Type
- String
createInjectableAccessEngineCode(accessEngineCode) → {string}
Creates injectable Access Engine code from the specified Access Engine code to allow it to be injected into a page and used.
This method can be used to inject Access Engine into the page yourself rather than having Continuum do it for you.
Parameters:
| Name | Type | Description |
|---|---|---|
accessEngineCode |
string | Access Engine JavaScript code |
- Source:
Returns:
- Type
- string
createInjectableHarvesterCode(harvesterCode) → {string}
Creates injectable Harvester code from the specified Harvester code to allow it to be injected into a page and used.
This method can be used to inject Harvester into the page yourself rather than having Continuum do it for you.
Parameters:
| Name | Type | Description |
|---|---|---|
harvesterCode |
string | Harvester JavaScript code |
- Source:
Returns:
- Type
- string
getAccessibilityConcerns() → {Array.<AccessibilityConcern>}
Gets the list of accessibility concerns found by Access Engine during the last test execution.
- Source:
Returns:
- Type
- Array.<AccessibilityConcern>
getAssertions() → {Array.<Assertion>}
Gets the array of assertions tested by Access Engine during the last test execution.
- Source:
Returns:
- Type
- Array.<Assertion>
(async) getPageMetadata() → {Metadata}
Retrieves the set of metadata for the current page.
- Source:
Returns:
- Type
- Metadata
getSupportedBestPractices() → {object}
Gets an object of key-value pairs, where the keys are IDs of best practices (defined in AMP and supported by Continuum) and the values are their descriptions.
Make sure to invoke this Continuum#setUp method before invoking this method.
- Source:
Returns:
- Type
- object
getSupportedStandards() → {object}
Gets an object of key-value pairs, where the keys are IDs of accessibility standards (defined in AMP and supported by Continuum) and the values are their names.
Make sure to invoke this Continuum#setUp method before invoking this method.
- Source:
Returns:
- Type
- object
getSupportedTests() → {object}
Gets an object of key-value pairs, where the keys are IDs of automatic Access Engine tests (supported by Continuum) and the values are their descriptions.
Make sure to invoke this Continuum#setUp method before invoking this method.
- Source:
Returns:
- Type
- object
(async) harvestLinks(linkSources, noFollow, stripFragment, stripQueryString) → {Array.<string>}
Retrieves the set of links for the current page including from shadow DOM.
The returned URLs are resolved against the location of the document from which they are harvested if relative.
Values that cannot be determined to directly lead to a resource will be ignored (e.g.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
linkSources |
LinkSource | Array.<LinkSource> | An array of link types that are to be harvested from. Defaults to elements. | |
noFollow |
boolean | false | Flags whether or not noFollow instructions are enforced. Defaults to false. |
stripFragment |
boolean | false | Flags whether or not to strip fragments from the end of harvested links. Defaults to false. |
stripQueryString |
boolean | false | Flags whether or not to strip query strings from harvested links. Defaults to false. |
- Source:
Returns:
- Type
- Array.<string>
runAllTests(includeiframe) → {Promise.<Array.<AccessibilityConcern>>}
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
includeiframe |
boolean | false | to include scanning iframe content |
- Source:
Returns:
- Type
- Promise.<Array.<AccessibilityConcern>>
runAllTestsForAssertions(includeiframe) → {Promise.<Array.<Assertion>>}
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
includeiframe |
boolean | false | to include scanning iframe content |
- Source:
Returns:
- Type
- Promise.<Array.<Assertion>>
runAllTestsOnNode(targetNodeOrCssSelectorForTargetNode, includeiframe) → {Promise.<Array.<AccessibilityConcern>>}
Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to | |
includeiframe |
boolean | false | to include scanning iframe content |
- Source:
Returns:
- Type
- Promise.<Array.<AccessibilityConcern>>
runTests(engineTestIds, includeiframe) → {Promise}
Runs only the specified automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
engineTestIds |
Array.<number> | the IDs of the automatic Access Engine tests to test for (invoke Continuum#getSupportedTests for a list of these, or consult AMP) | |
includeiframe |
boolean | false | to include scanning iframe content |
- Source:
Returns:
- Type
- Promise
runTestsOnNode(engineTestIds, targetNodeOrCssSelectorForTargetNode) → {Promise}
Runs only the specified automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
engineTestIds |
Array.<number> | the IDs of the automatic Access Engine tests to test for (invoke Continuum#getSupportedTests for a list of these, or consult AMP) |
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to |
- Source:
Returns:
- Type
- Promise
(async) setIncludePotentialAccessibilityConcerns(includePotentialAccessibilityConcerns) → {Promise}
Globally sets whether or not accessibility concerns that require manual review are included in any of Continuum's test results.
If enabled, any accessibility concerns that require manual review will have AccessibilityConcern#needsReview return true.
This method is only available in the Pro edition of Continuum, otherwise it will return a Promise that rejects immediately.
Parameters:
| Name | Type | Description |
|---|---|---|
includePotentialAccessibilityConcerns |
boolean | whether or not accessibility concerns that require manual review should be returned in any of Continuum's test results |
- Source:
Returns:
- Type
- Promise
(async) setUp(webDrivernullable, configPathOrObjectnullable, windownullable, browsernullable)
Sets up Continuum for web testing.
Either the webDriver or window parameter must be specified here.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
webDriver |
* |
<nullable> |
a Selenium web driver to test with |
configPathOrObject |
string | object |
<nullable> |
either the absolute path to a valid continuum.conf.js file or an object containing the configuration properties; null if you've already loaded this yourself and have supplied a window object |
window |
Window |
<nullable> |
the window whose content should be tested |
browser |
* |
<nullable> |
a WebDriverIO browser to test with |
- Source:
setWindowUnderTest(targetWindow) → {Promise}
Sets the window to test.
This can be used to set the testing context to the contents of an iframe element on the page, rather than the page an iframe element appears on.
Parameters:
| Name | Type | Description |
|---|---|---|
targetWindow |
Window | the window to inject Access Engine into and prepare to test |
- Source:
Returns:
- Type
- Promise
testForBestPractices(bestPracticeIds) → {Promise}
Runs only the automatic Access Engine tests corresponding to the specified best practices against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
bestPracticeIds |
Array.<number> | the IDs of the best practices to test for (invoke Continuum#getSupportedBestPractices for a list of these, or consult AMP) |
- Source:
Returns:
- Type
- Promise
testForNoticeability(minNoticeability) → {Promise}
Runs only the automatic Access Engine tests of or greater than the specified noticeability against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
minNoticeability |
number | the inclusive minimum noticeability of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable |
- Source:
Returns:
- Type
- Promise
testForSeverity(minSeverity) → {Promise}
Runs only the automatic Access Engine tests of or greater than the specified severity against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
minSeverity |
number | the inclusive minimum severity of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least severe and 10 is the most severe |
- Source:
Returns:
- Type
- Promise
testForStandards(standardIds) → {Promise}
Runs only the automatic Access Engine tests corresponding to the specified accessibility standards against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Note that the IDs of the specified accessibility standards must also be specified by Configuration#getAccessEngineType, otherwise no accessibility concerns will be returned.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
standardIds |
Array.<number> | the IDs of the accessibility standards to test for (invoke Continuum#getSupportedStandards for a list of these, or consult AMP) |
- Source:
Returns:
- Type
- Promise
testForTractability(minTractability) → {Promise}
Runs only the automatic Access Engine tests of or greater than the specified tractability against the current page, as defined by the web driver used previously to invoke Continuum#setUp.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
minTractability |
number | the inclusive minimum tractability of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least tractable and 10 is the most tractable |
- Source:
Returns:
- Type
- Promise
testNodeForBestPractices(bestPracticeIds, targetNodeOrCssSelectorForTargetNode) → {Promise}
Runs only the automatic Access Engine tests corresponding to the specified best practices against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
bestPracticeIds |
Array.<number> | the IDs of the best practices to test for (invoke Continuum#getSupportedBestPractices for a list of these, or consult AMP) |
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to |
- Source:
Returns:
- Type
- Promise
testNodeForNoticeability(minNoticeability, targetNodeOrCssSelectorForTargetNode) → {Promise}
Runs only the automatic Access Engine tests of or greater than the specified noticeability against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
minNoticeability |
number | the inclusive minimum noticeability of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable |
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to |
- Source:
Returns:
- Type
- Promise
testNodeForSeverity(minSeverity, targetNodeOrCssSelectorForTargetNode) → {Promise}
Runs only the automatic Access Engine tests of or greater than the specified severity against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
minSeverity |
number | the inclusive minimum severity of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable |
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to |
- Source:
Returns:
- Type
- Promise
testNodeForStandards(standardIds, targetNodeOrCssSelectorForTargetNode) → {Promise}
Runs only the automatic Access Engine tests corresponding to the specified accessibility standards against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Note that the IDs of the specified accessibility standards must also be specified by Configuration#getAccessEngineType, otherwise no accessibility concerns will be returned.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
standardIds |
Array.<number> | the IDs of the accessibility standards to test for (invoke Continuum#getSupportedStandards for a list of these, or consult AMP) |
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to |
- Source:
Returns:
- Type
- Promise
testNodeForTractability(minTractability, targetNodeOrCssSelectorForTargetNode) → {Promise}
Runs only the automatic Access Engine tests of or greater than the specified tractability against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke Continuum#setUp and the specified node or its CSS selector.
Make sure to invoke this Continuum#setUp method before invoking this method.
Parameters:
| Name | Type | Description |
|---|---|---|
minTractability |
number | the inclusive minimum tractability of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable |
targetNodeOrCssSelectorForTargetNode |
Element | string | the target node, or its CSS selector, to restrict accessibility testing to |
- Source:
Returns:
- Type
- Promise