@applitools/visual-grid-client
Advanced tools
Comparing version 4.0.8 to 4.0.9
{ | ||
"name": "@applitools/visual-grid-client", | ||
"version": "4.0.8", | ||
"version": "4.0.9", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "src/visual-grid-client.js", |
@@ -15,3 +15,3 @@ # visual-grid-client | ||
const {makeVisualGridClient, initConfig} = require('@applitools/visual-grid-client') | ||
const domNodesToCdt = require('@applitools/visual-grid-client/src/browser-util/domNodesToCdt') | ||
``` | ||
@@ -54,3 +54,3 @@ | ||
`openEyes` will create a test. Actually, it will create a series of test, one for each browser configuration | ||
Async function `openEyes` will create a test. Actually, it will create a series of test, one for each browser configuration | ||
defined in the `browser` property of the configuraion. | ||
@@ -61,3 +61,3 @@ | ||
* Returns an object with the following functions: | ||
* Returns a promise to an object with the following functions: | ||
@@ -76,3 +76,4 @@ * `checkWindow(...)`: creates a "step" that checks the window according to the baseline. Note that this | ||
* `url`: the URL appearing in the address bar of the browser. All relative URLs in the CDT will be relative to it. | ||
* `cdt`: the HTML and set and resources, in the `x-applitools-html/cdt` format (see below) | ||
* `cdt`: the HTML and set and resources, in the `x-applitools-html/cdt` format (see below). | ||
you can use `domNodesToCdt` to create a CDT from a `document`. | ||
* `sizeMode`: the target of the rendering. Can be one of `viewport`, `full-page`, `selector`, `region` | ||
@@ -129,2 +130,7 @@ * `selector`: if the `sizeMode` is selector, this is the selector we are targetting. | ||
### domNodesToCdt | ||
Accepts a document object conforming to the DOM specification (browser document is fine, as is the JSDOM document). | ||
Returns a cdt, ready to be passed to `checkWindow` | ||
## Configuration | ||
@@ -131,0 +137,0 @@ |
56427
140