API

(See Advanced Usage for the meaning of compare, write and default workflow)

All four public API methods accept the same method signature:

• huxley.writeScreenshots(opts)
• huxley.recordTasks(opts)
• huxley.compareScreenshots(opts)
• huxley.defaultWorkflow(opts)

(In fact, the huxley CLI simply dogfoods this API)

opts is an object of the following shape:

{
  //Array of globs that searches the `Huxleyfile.json`s you want to target. Defaults to `./**/*Huxleyfile.json`
  globs: ['./someFolder/Huxleyfile.json', 'someOtherFolder/Huxleyfile.json'],
  // That's the default browser shipped by Selenium is firefox. 'chrome' is also available if you have `chromedriver`
  browserName: 'firefox',
  serverUrl: 'http://localhost:4444/wd/hub', // default Selenium firefox server address when you start `selenium`
  taskName: 'toggle button', // defaults to `null` (aka, run every task in every Huxleyfile)
  injectedDriver: customDriver // for advance uses, such as connecting to BrowserStack
}

All four APIs return a Promise upon completion.