# @wdio/protocols

> Utility package providing information about automation protocols

Latest version **10.0.2** (published 2026-10-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wdio/protocols
pnpm add @wdio/protocols
yarn add @wdio/protocols
bun add @wdio/protocols
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 10.0.2 |
| Published | 2026-10-08 |
| First published | 2019-09-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=22.19.0 |
| Dependencies | 0 |
| Unpacked size | 437.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 9842 |
| Author | Christian Bromann |
| Maintainers | christian-bromann, wdio-user, wswebcreation-nl |
| Keywords | webdriver, wdio |

## Links

- npm: https://www.npmjs.com/package/@wdio/protocols
- Repository: https://github.com/webdriverio/webdriverio
- Homepage: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-protocols
- Issues: https://github.com/webdriverio/webdriverio/issues
- npm.io page: https://npm.io/package/@wdio/protocols

## Recent versions

- 10.0.2 (latest) — 2026-10-08
- 10.1.0-alpha.30 (next) — 2026-10-07
- 8.44.0 (v8) — 2025-04-08
- 9.0.0-alpha.0 (v9) — 2024-03-12
- 7.0.0-beta.1 (beta) — 2021-02-02
- 10.1.0-alpha.29 — 2026-10-07
- 10.1.0-alpha.26 — 2026-10-06
- 10.1.0-alpha.25 — 2026-10-06
- 10.1.0-alpha.19 — 2026-10-06
- 10.1.0-alpha.18 — 2026-10-06
- 10.0.0 — 2026-10-05
- 10.0.0-alpha.175 — 2026-10-04
- 10.0.0-alpha.165 — 2026-10-04
- 10.0.0-alpha.163 — 2026-10-04
- 10.0.0-alpha.172 — 2026-10-04
- … 179 more at https://npm.io/package/@wdio/protocols/versions

## README

WebdriverIO Protocol Helper
===========================

This package stores the definition for various automation protocols such as [WebDriver](https://w3c.github.io/webdriver/) or vendor specific protocol extensions like for [SauceLabs](https://saucelabs.com/). Unless you are interested in generating a WebDriver client there should be no reason why you should need this package. This package holds the definition of the following protocols:

- [WebDriver](https://w3c.github.io/webdriver/)
- [Appium](http://appium.io/)
- [Sauce Labs](https://saucelabs.com/)
- Chrome (WebDriver extension when running Chromedriver)
- Selenium (when running Selenium Standalone Server)

## Install

To install the package, run:

```sh
npm install @wdio/protocols
```

## Usage

You can get data by importing the package as follows:

```js
import { WebDriverProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol } from '@wdio/protocols'

/**
 * get description of session command
 */
console.log(WebDriverProtocol['/session'].POST.description)
```

## TypeScript Interfaces

The package exposes TypeScript interfaces for all protocols. You can use them for your own project as follows:

```ts
import type { WebDriverCommands } from '@wdio/protocol'

import { WebDriverCommands, WebDriverCommandsAsync } from './src'

const browser = {} as WebDriverCommands
browser.sendAlertText(true)
// fails with "Argument of type 'boolean' is not assignable to parameter of type 'string'.ts(2345)"

const asyncBrowser = {} as WebDriverCommandsAsync
const a = await asyncBrowser.getTitle()
type foo = typeof a // string
```

----

For more information on WebdriverIO see the [homepage](https://webdriver.io).

---
_Source: https://npm.io/package/@wdio/protocols · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._