Skip to content
This repository has been archived by the owner on Nov 24, 2018. It is now read-only.

Add options documentation #243

Merged
merged 1 commit into from
Aug 30, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

Chromeless provides TypeScript typings.

**Chromeless constructor options**

`new Chromeless(options: ChromelessOptions)`

- `debug: boolean` Show debug output — Default: `false`
- `remote: boolean` Use remote chrome process — Default: `false`
- `implicitWait: boolean` Wait for element to exist before executing commands — Default: `false`
- `waitTimeout: number` Time in ms to wait for element to appear — Default: `10000`
- `scrollBeforeClick: boolean` Scroll to element before clicking, usefull if element is outside of viewport — Default: `false`
- `viewport: any` Viewport dimensions — Default: `{width: 1440, height: 900, scale: 1}`
- `launchChrome: boolean` Auto-launch chrome (local) — Default: `true`
- `cdp: CDPOptions` Chome Debugging Protocol Options — Default: `{host: 'localhost', port: 9222, secure: false, closeTab: true}`

**Chromeless methods**
- [`end()`](#api-end)

Expand Down