Andrey Lushnikov 549535e674 Add docs/api.md
This patch adds docs/api.md file which contains API description
for the puppeteer API. This patch adds the API outline, which
doesn't not have explanations and samples.
2017-06-13 00:28:39 -07:00
2017-06-13 00:28:39 -07:00
2017-06-13 00:28:39 -07:00
2017-06-11 01:32:59 -07:00
2017-05-14 23:28:00 -07:00
2017-06-11 01:32:59 -07:00
2017-06-11 22:44:50 -07:00
2017-05-12 16:38:07 -07:00

Status

Test results on Mac OS X in headless mode:

  111 passed
   20 failed as expected
    1 skipped
   49 unsupported

Installing

npm i
npm link # this adds puppeteer to $PATH

Run

# run phantomjs script
puppeteer third_party/phantomjs/examples/colorwheel.js

# run 'headful'
puppeteer --no-headless third_party/phantomjs/examples/colorwheel.js

# run puppeteer example
node examples/screenshot.js

Tests

Run all tests:

npm test

Run phantom.js tests using puppeteer:

npm run test-phantom

Run puppeteer tests:

npm run test-puppeteer
Languages
TypeScript 93.2%
JavaScript 5.1%
HTML 1.2%
CSS 0.3%
MDX 0.1%