@wdio/types

What is @wdio/types?

@wdio/types is a TypeScript type definitions package for WebdriverIO, a popular automation test framework. It provides type definitions for various WebdriverIO components, making it easier to write type-safe code when using WebdriverIO.

What are @wdio/types's main functionalities?

Type Definitions for WebdriverIO Configuration

This feature provides type definitions for WebdriverIO configuration objects, ensuring that the configuration adheres to the expected structure and types.

const config: WebdriverIO.Config = { runner: 'local', specs: ['./test/specs/**/*.js'], capabilities: [{ browserName: 'chrome' }] };

Type Definitions for WebdriverIO Commands

This feature provides type definitions for WebdriverIO commands, allowing for type-safe interactions with the browser and elements.

browser.url('https://example.com'); const title: string = browser.getTitle();

Type Definitions for WebdriverIO Hooks

This feature provides type definitions for WebdriverIO hooks, ensuring that hooks are implemented with the correct parameters and return types.

const hooks: WebdriverIO.Hooks = { before: (capabilities, specs) => { console.log('Before hook'); } };

Other packages similar to @wdio/types

webdriverio

WebdriverIO is the main package for the WebdriverIO framework, providing the core functionality for browser automation. While @wdio/types focuses on type definitions, webdriverio provides the actual implementation of the automation commands and features.

selenium-webdriver

selenium-webdriver is the official JavaScript implementation of the Selenium WebDriver API. It provides similar browser automation capabilities as WebdriverIO but does not come with built-in TypeScript type definitions, making @wdio/types a better choice for TypeScript users.

cypress

Cypress is an end-to-end testing framework that provides a different approach to browser automation compared to WebdriverIO. It comes with built-in TypeScript support, but its API and architecture differ significantly from WebdriverIO.

README

WebdriverIO Types

This package contains a bunch of TypeScript types for internal WebdriverIO consumption. Feel free however to use them in your TypeScript project too.

Install

To install this package from NPM run:

npm i @wdio/types

Example

The package exports the following major type bundles: Capabilities, Clients, Options, Services, Frameworks and Reporters. A lot of them are very WebdriverIO specific but you can leverage some, e.g.

import type { Capabilities } from '@wdio/types';

const w3cCaps: Capabilities.W3CCapabilities = {
    alwaysMatch: {...},
    firstMatch: [],
    // fails with "Object literal may only specify known properties, and 'invalid' does not exist in type 'W3CCapabilities'.ts(2322)"
    invalid: 42
}

For details please take a look into the individual files.

---

For more information on WebdriverIO see the homepage.