An example project using Typescript and WebdriverIO
Switch branches/tags
Nothing to show
Clone or download
Will Luce Will Luce
Will Luce and Will Luce modifies paths for scripts
Latest commit f000971 Feb 3, 2017


This directory contains the WebdriverIO page object example written using TypeScript. The usefullness of the page object pattern is discussed on the WebdriverIO website.

Getting Started

git clone
cd WebdriverIO_Typescript
npm install
npm test

Why TypeScript

In short, TypeScript is a superset of JavaScript (as in all that "coming in ES6/7!" already built in) that allows optional typing.

Future Features

TypeScript compiles down to JavaScript using settings in a .tsconfig file. Notable lines in this project's .tsconfig are...

Tell the compiler to allow the use of ES6/7 features

"experimentalDecorators": true,

Compile the .ts files into a /src directory

"outDir": "src/"

Don't try to compile the node_modules

"exclude": [

Don't compile every time the file is saved

"compileOnSave": false

More information at the TypeScript Website.


Adding typings to your functions and variables allows your text editor to better guess what you're trying to do next. More specifically to testing with WebdriverIO, browser elements will let you know what you can do with them and what they need to do their thing.


Typings for most libraries are availible from the DefinitelyTyped project and, since the release of TypeScript 2.0, can be installed via npm. For example

npm install @types/webdriverio

Pages From Objects to Classes

Each page is a class (mainly because it helps the intellisense) which is instantiated and exported.

class Login_Page {

    public get username()  { return browser.element('#username') }
    public get password()  { return browser.element('#password') }
    public get form()      { return browser.element('#login') }
    public get flash()     { return browser.element('#flash') }

    public open(): void {
    public submit(): void {

const LoginPage = new Login_Page()
export default LoginPage

Running Tests

The WebdriverIO Test Runner still needs .js files to test, so we modify the npm test script to compile the .ts files into a /src directory, then run the tests from there. Then, rimraf is used to delete the /src directory so as to not clutter up the working space.

"scripts": {
  "test": "node ./node_modules/typescript/lib/tsc.js && node_modules/webdriverio/bin/wdio && node_modules/rimraf/bin.js src"

Notice that the wdio.config.json file knows to look in /src for specs

specs: [