Skip to content

fix: tsc error with elements matcher and type WebdriverIO.Element[] #1979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
christian-bromann merged 2 commits into from
Jan 4, 2026
Merged

fix: tsc error with elements matcher and type WebdriverIO.Element[] #1979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4347a9
fix: tsc error with elements matcher and type `WebdriverIO.Element[]`
dprevost-LMI Dec 28, 2025
edda860
chore: add checks:all command to eases checks everything
dprevost-LMI Dec 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
"ts:mocha": "cd test-types/mocha && tsc --project ./tsconfig.json",
"ts:jasmine": "cd test-types/jasmine && tsc --project ./tsconfig.json",
"ts:jasmine-async": "cd test-types/jasmine-async && tsc --project ./tsconfig.json",
"checks:all": "npm run build && npm run compile && npm run tsc:root-types && npm run test && npm run ts",
"watch": "npm run compile -- --watch",
"prepare": "husky install"
},
Expand Down
21 changes: 21 additions & 0 deletions test-types/mocha/types-mocha.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ describe('type assertions', () => {

const element: WebdriverIO.Element = {} as unknown as WebdriverIO.Element
const elementArray: WebdriverIO.ElementArray = [] as unknown as WebdriverIO.ElementArray
const elements: WebdriverIO.Element[] = [] as unknown as WebdriverIO.Element[]

const networkMock: WebdriverIO.Mock = {} as unknown as WebdriverIO.Mock

Expand Down Expand Up @@ -323,6 +324,26 @@ describe('type assertions', () => {
expectVoid = expect(chainableArray).toBeElementsArrayOfSize({ lte: 10 })
})

it('should work correctly when actual is element array', async () => {
expectPromiseVoid = expect(elementArray).toBeElementsArrayOfSize(5)
expectPromiseVoid = expect(elementArray).toBeElementsArrayOfSize({ lte: 10 })

// @ts-expect-error
expectVoid = expect(elementArray).toBeElementsArrayOfSize(5)
// @ts-expect-error
expectVoid = expect(elementArray).toBeElementsArrayOfSize({ lte: 10 })
})

it('should work correctly when actual is element[]', async () => {
expectPromiseVoid = expect(elements).toBeElementsArrayOfSize(5)
expectPromiseVoid = expect(elements).toBeElementsArrayOfSize({ lte: 10 })

// @ts-expect-error
expectVoid = expect(elements).toBeElementsArrayOfSize(5)
// @ts-expect-error
expectVoid = expect(elements).toBeElementsArrayOfSize({ lte: 10 })
})

it('should not work when actual is not chainableArray', async () => {
// @ts-expect-error
await expect(chainableElement).toBeElementsArrayOfSize(5)
Expand Down
2 changes: 1 addition & 1 deletion types/expect-webdriverio.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ type WdioOnlyMaybePromiseLike = ElementPromise | ElementArrayPromise | Chainable
*/
type ElementOrArrayLike = ElementLike | ElementArrayLike
type ElementLike = WebdriverIO.Element | ChainablePromiseElement
type ElementArrayLike = WebdriverIO.ElementArray | ChainablePromiseArray
type ElementArrayLike = WebdriverIO.ElementArray | ChainablePromiseArray | WebdriverIO.Element[]
type MockPromise = Promise<WebdriverIO.Mock>

/**
Expand Down