Classes

Tab ⇐ EventEmitter

Objects

Chrome : object

Constants

CHROME_BIN : string: (Environment variable) location of Chrome executable
CHROME_PORT : number: (Environment variable) port to use

Functions

__chromate(): Function loaded in target to communicate back to runner.

Tab ⇐ `EventEmitter`

Kind: global class
Extends: EventEmitter

Tab ⇐ EventEmitter
- new Tab([options])
- instance
  - .open(targetUrl) ⇒ Promise.<Tab>
  - .close() ⇒ Promise
  - .execute(func, ...args, options) ⇒ Promise.<result>
  - .evaluate(expr, options) ⇒ Promise.<result>
- static
  - .settings
  - .list([options]) ⇒ Promise.<Array>
  - .open(targetUrl, [options]) ⇒ Promise.<Tab>
  - .close(tabId, [options]) ⇒ Promise
  - .closeAll([options]) ⇒ Promise.<Number>
  - "done"
  - "ready"
  - "load"
  - "event"
  - "console.<type>"
  - "console"
  - "exception"
  - "abort"
  - "data"

new Tab([options])

Param	Type	Description
[options]	`object`	see settings

tab.open(targetUrl) ⇒ `Promise.<Tab>`

Open a new tab at url.

tab.close() ⇒ `Promise`

Close a tab opened by open()

Kind: instance method of Tab

tab.execute(func, ...args, options) ⇒ `Promise.<result>`

Execute a (named) function in target and get the result.

The function should return simple text values or use JSON.stringify.

Pass options.awaitPromise if the function returns a Promise.

Kind: instance method of Tab
Returns: Promise.<result> - Promise gets return value of function. Objects (including Arrays) should be JSON.stringify'd.

Param	Type	Description
func	`string` \| `function`	function name in target, or function, to execute in target.
...args	`any`	additional arguments to pass to function
options	`object`	options to pass to client.Runtime.evaluate().

Example

tab.execute('getResults').then(result => console.log )  // {a:1}

  // in target:
  function getResult() { return JSON.stringify({a:1}); }

Example

tab.execute(function(){ return document.title })
   .then(result => console.log) // -> foo bar

  // in target html:  <title>foo bar</title>

tab.evaluate(expr, options) ⇒ `Promise.<result>`

Evaluate an expression in target and get the result.

Kind: instance method of Tab
Returns: Promise.<result> - Promise gets return value of expression.

Param	Type	Description
expr	`string`	expression in target to evaluate
options	`object`	options to pass to client.Runtime.evaluate().

Example

// Objects must be evaluated using JSON.stringify:
  tab.evaluate('JSON.stringify( data )').then(result => console.log) // data object

Example

tab.evaluate('one + two').then(result => console.log) // 3

  // in target
  var one = 1;
  var two = 2;

Tab.settings

Default settings. May be overridden by passing in options.

Kind: static property of Tab
Properties

Name	Type	Default	Description
port	`number`	`9222`	port number of Chrome instance. Or set env variable CHROME_PORT.
failonerror	`boolean`	`true`	stop processing and close tab in case of network or other errors
verbose	`boolean`	`false`	log info and console.logs
screenshot	`boolean`	`false`	take a screenshot (WIP!)
viewport	`object`	`width:680,height:800`	window width & height
waitForDone	`boolean`	`false`	set to true to have tab wait for a 'done' event from the target. The result is returned in tab.result.
timeout	`number`	`0`	tab rejects and closes after this time in msec (0 to disable)

Tab.list([options]) ⇒ `Promise.<Array>`

List all open tabs

Kind: static method of Tab
Returns: Promise.<Array> - of tab objects

Param	Type	Description
[options]	`object`	options.port of Chrome process

Tab.open(targetUrl, [options]) ⇒ `Promise.<Tab>`

Open a tab at target url. Short hand for new Tab(url, opt).open().

Kind: static method of Tab

Param	Type	Default	Description
targetUrl	`string`	`""about:blank""`	url to load in tab
[options]	`object`		see settings

Tab.close(tabId, [options]) ⇒ `Promise`

Close a tab with given tab Id.

Kind: static method of Tab

Param	Type	Description
tabId	`string`	id of tab to close
[options]	`object`	options.port of Chrome process

Tab.closeAll([options]) ⇒ `Promise.<Number>`

Close all tabs

Kind: static method of Tab
Returns: Promise.<Number> - no. of tabs closed

Param	Type	Description
[options]	`object`	{port} no.