Upgrading appium-geckodriver from 3.x to 4.x

Comparison of the public API of appium-geckodriver 3.0.18 and 4.0.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	1
Changed signatures	0
Removed class or interface members	0
Changed class or interface members	2
Newly deprecated	0
Requirement changes (engines, peer dependencies)	2
New exports	0

Removed exports

import	export	kind	Before
`appium-geckodriver`	`default`	class	`class`

Changed signatures

None detected.

Removed class or interface members

None detected.

Changed class or interface members

member	Before	After
`GeckoDriver.findElOrEls`	`(this: GeckoDriver, strategy: string, selector: string, mult: boolean, context?: string \| undefined): Promise<any>`	`(strategy: string, selector: string, mult: boolean, context?: string \| undefined): Promise<any>`
`GeckoDriver.createSession`	`(w3cCaps1: W3CDriverCaps<{ readonly browserName: { readonly isString: true; }; readonly browserVersion: { readonly isString: true; }; readonly acceptInsecureCerts: { readonly isBoolean: true; }; readonly pageLoadStrategy: { readonly isString: true; }; readonly proxy: { readonly isObject: true; }; re…`	`(w3cCapabilities: W3CDriverCaps<{ readonly browserName: { readonly isString: true; }; readonly browserVersion: { readonly isString: true; }; readonly acceptInsecureCerts: { readonly isBoolean: true; }; readonly pageLoadStrategy: { readonly isString: true; }; readonly proxy: { readonly isObject: true…`

Newly deprecated

None detected.

Requirement changes (engines, peer dependencies)

	Before	After
`engines.node`	`^20.19.0 \|\| ^22.12.0 \|\| >=24.0.0`	`^22.22.2 \|\| ^24.15.0 \|\| >=26.0.0`
`peerDependencies.appium`	`^3.0.0-rc.2`	`^4.0.0-beta.6`

Changelog between these versions

Text published by the package authors, shown as-is.

4.0.0

### ⚠ BREAKING CHANGES

* Requires Appium ^4.0.0-beta.6 (peer dependency). No longer compatible with Appium 3.
* Drops Node 20. The minimum is now ^22.22.2 || ^24.15.0 || >=26.0.0, matching Appium 4's engine range.
* Driver API: createSession takes a single w3cCapabilities argument, following the Appium 4 base driver. This only matters to anyone subclassing the driver.
* Default exports removed: the package no longer has a default export. Use the named export instead: import {GeckoDriver} from 'appium-geckodriver'.
* Command methods live on the prototype: findElOrEls is attached to GeckoDriver.prototype (with declare module typings) rather than being an instance field, so subclasses can call super for it.

### Features

* add Appium 4 support ([#209](https://github.com/appium/appium-geckodriver/issues/209)) ([ad588cf](https://github.com/appium/appium-geckodriver/commit/ad588cffe4be2219ef57f602cf06978286772581))

### Code Refactoring

* use ConditionUnmetError instead of message matching ([#208](https://github.com/appium/appium-geckodriver/issues/208)) ([05bc271](https://github.com/appium/appium-geckodriver/commit/05bc271eb6f559087ed34260f12b981119db2451))

Give your AI agent these facts

Vigia is a free MCP server: your coding agent checks versions, breaking changes and vulnerabilities before it writes code. No signup, no API key.

claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp

Add to Cursor Add to VS Code ★ Star on GitHub

Any other MCP client

{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }

Agent skill (SKILL.md): tells the agent when to use Vigia · GitHub Action for pull requests

Frequently asked questions

What are the breaking changes when upgrading appium-geckodriver from 3 to 4?

Between appium-geckodriver 3.0.18 and 4.0.0, Vigia found 1 removed exports, 0 changed signatures and 2 removed or changed class or interface members.

What became deprecated in appium-geckodriver 4?

0 exports or members are newly marked as deprecated in appium-geckodriver 4.0.0.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/appium-geckodriver/upgrade?from=3.0.18&to=4.0.0