@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

Readme

Source

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 { 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.

Keywords

FAQs

What is @wdio/types?

Is @wdio/types well maintained?

Last updated on 06 Oct 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install