Skip to content

Commit 3fdc1bd

Browse files
(docs): deprecate xxxContaining APIs
1 parent 89fe30b commit 3fdc1bd

File tree

1 file changed

+103
-6
lines changed

1 file changed

+103
-6
lines changed

docs/API.md

Lines changed: 103 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,16 @@ await expect(browser).toHaveUrl('https://webdriver.io')
106106

107107
Checks if browser is on a page URL that contains a value.
108108

109+
__Deprecated:__ please use `expect.stringContaining()` instead!
110+
109111
##### Usage
110112

111113
```js
112114
await browser.url('https://webdriver.io/')
115+
// 👎 deprecated
113116
await expect(browser).toHaveUrlContaining('webdriver')
117+
// 👍 supported starting with v9
118+
await expect(browser).toHaveUrl(expect.stringContaining('webdriver'))
114119
```
115120

116121
### toHaveTitle
@@ -128,11 +133,16 @@ await expect(browser).toHaveTitle('WebdriverIO · Next-gen browser and mobile au
128133

129134
Checks if website has a specific title that contains a value.
130135

136+
__Deprecated:__ please use `expect.stringContaining()` instead!
137+
131138
##### Usage
132139

133140
```js
134141
await browser.url('https://webdriver.io/')
142+
// 👎 deprecated
135143
await expect(browser).toHaveTitleContaining('WebdriverIO')
144+
// 👍 supported starting with v9
145+
await expect(browser).toHaveTitle(expect.stringContaining('WebdriverIO'))
136146
```
137147

138148
### toHaveClipboardText
@@ -151,17 +161,21 @@ await expect(browser).toHaveClipboardText('some clipboard text')
151161

152162
### toHaveClipboardTextContaining
153163

154-
155164
Checks if the browser has a specific text stored in its clipboard that contains a given string.
156165

166+
__Deprecated:__ please use `expect.stringContaining()` instead!
167+
157168
##### Usage
158169

159170
```js
160171
import { Key } from 'webdriverio'
161172

162173
await browser.keys([Key.Ctrl, 'a'])
163174
await browser.keys([Key.Ctrl, 'c'])
175+
// 👎 deprecated
164176
await expect(browser).toHaveClipboardTextContaining('clipboard')
177+
// 👍 supported starting with v9
178+
await expect(browser).toHaveClipboardText(expect.stringContaining('WebdriverIO'))
165179
```
166180

167181
## Element Matchers
@@ -247,22 +261,32 @@ await expect(myInput).toHaveAttr('class', 'form-control')
247261

248262
Checks if an element has a certain attribute that contains a value.
249263

264+
__Deprecated:__ please use `expect.stringContaining()` instead!
265+
250266
##### Usage
251267

252268
```js
253269
const myInput = await $('input')
270+
// 👎 deprecated
254271
await expect(myInput).toHaveAttributeContaining('class', 'form')
272+
// 👍 supported starting with v9
273+
await expect(myInput).toHaveAttribute('class', expect.stringContaining('form'))
255274
```
256275

257276
### toHaveAttrContaining
258277

259278
Same as `toHaveAttributeContaining`.
260279

280+
__Deprecated:__ please use `expect.stringContaining()` instead!
281+
261282
##### Usage
262283

263284
```js
264285
const myInput = await $('input')
286+
// 👎 deprecated
265287
await expect(myInput).toHaveAttrContaining('class', 'form')
288+
// 👍 supported starting with v9
289+
await expect(myInput).toHaveAttr('class', expect.stringContaining('form'))
266290
```
267291

268292
### toHaveElementClass
@@ -280,11 +304,16 @@ await expect(myInput).toHaveElementClass('form-control', { message: 'Not a form
280304

281305
Checks if an element has a certain class name that contains provided value.
282306

307+
__Deprecated:__ please use `expect.stringContaining()` instead!
308+
283309
##### Usage
284310

285311
```js
286312
const myInput = await $('input')
313+
// 👎 deprecated
287314
await expect(myInput).toHaveElementClassContaining('form')
315+
// 👍 supported starting with v9
316+
await expect(myInput).toHaveElementClass(expect.stringContaining('form'))
288317
```
289318

290319
### toHaveElementProperty
@@ -314,11 +343,16 @@ await expect(myInput).toHaveValue('user', { ignoreCase: true })
314343

315344
Checks if an input element contains a certain value.
316345

346+
__Deprecated:__ please use `expect.stringContaining()` instead!
347+
317348
##### Usage
318349

319350
```js
320351
const myInput = await $('input')
352+
// 👎 deprecated
321353
await expect(myInput).toHaveValueContaining('us')
354+
// 👍 supported starting with v9
355+
await expect(myInput).toHaveValue(expect.stringContaining('us'))
322356
```
323357

324358
### toBeClickable
@@ -397,13 +431,22 @@ await expect(elem).toHaveComputedLabel(['GitHub repository', 'Private repository
397431

398432
Checks if element contains a specific computed WAI-ARIA label. Can also be called with an array as parameter in the case where the element can have different labels.
399433

434+
__Deprecated:__ please use `expect.stringContaining()` instead!
435+
400436
##### Usage
401437

402438
```js
403439
await browser.url('https://webdriver.io/')
404440
const elem = await $('a[href="https://github.com/webdriverio/webdriverio"]')
441+
// 👎 deprecated
405442
await expect(elem).toHaveComputedLabelContaining('GitHub')
406443
await expect(elem).toHaveComputedLabelContaining(['GitHub', 'Private'])
444+
// 👍 supported starting with v9
445+
await expect(elem).toHaveComputedLabel(expect.stringContaining('us'))
446+
await expect(elem).toHaveComputedLabel([
447+
expect.stringContaining('GitHub'),
448+
expect.stringContaining('us')
449+
])
407450
```
408451

409452
### toHaveComputedRole
@@ -423,13 +466,22 @@ await expect(elem).toHaveComputedRole(['region', 'section'])
423466

424467
Checks if element contains a specific computed WAI-ARIA role. Can also be called with an array as parameter in the case where the element can have different roles.
425468

469+
__Deprecated:__ please use `expect.stringContaining()` instead!
470+
426471
##### Usage
427472

428473
```js
429474
await browser.url('https://webdriver.io/')
430475
const elem = await $('[aria-label="Skip to main content"]')
476+
// 👎 deprecated
431477
await expect(elem).toHaveComputedRoleContaining('reg')
432478
await expect(elem).toHaveComputedRoleContaining(['reg', 'sec'])
479+
// 👍 supported starting with v9
480+
await expect(elem).toHaveComputedRole(expect.stringContaining('reg'))
481+
await expect(elem).toHaveComputedRole([
482+
expect.stringContaining('reg'),
483+
expect.stringContaining('sec')
484+
])
433485
```
434486

435487
### toHaveHref
@@ -458,22 +510,32 @@ await expect(link).toHaveLink('https://webdriver.io')
458510

459511
Checks if link element contains a specific link target.
460512

513+
__Deprecated:__ please use `expect.stringContaining()` instead!
514+
461515
##### Usage
462516

463517
```js
464518
const link = await $('a')
519+
// 👎 deprecated
465520
await expect(link).toHaveHrefContaining('webdriver.io')
521+
// 👍 supported starting with v9
522+
await expect(link).toHaveHref(expect.stringContaining('webdriver.io'))
466523
```
467524

468525
### toHaveLinkContaining
469526

470527
Same as `toHaveHrefContaining`.
471528

529+
__Deprecated:__ please use `expect.stringContaining()` instead!
530+
472531
##### Usage
473532

474533
```js
475534
const link = await $('a')
535+
// 👎 deprecated
476536
await expect(link).toHaveLinkContaining('webdriver.io')
537+
// 👍 supported starting with v9
538+
await expect(link).toHaveLink(expect.stringContaining('webdriver.io'))
477539
```
478540

479541
### toHaveId
@@ -504,13 +566,27 @@ await expect(elem).toHaveText(['Next-gen browser and mobile automation test fram
504566

505567
Checks if element contains a specific text. Can also be called with an array as parameter in the case where the element can have different texts.
506568

569+
__Deprecated:__ please use `expect.stringContaining()` instead!
570+
507571
##### Usage
508572

509573
```js
510574
await browser.url('https://webdriver.io/')
511-
const elem = await $('.container')
512-
await expect(elem).toHaveTextContaining('browser and mobile automation test framework')
513-
await expect(elem).toHaveTextContaining(['browser and mobile automation test framework', 'Started'])
575+
const elem = $('.container')
576+
// 👎 deprecated
577+
await expect(elem).toHaveTextContaining(
578+
'browser and mobile automation test framework')
579+
await expect(elem).toHaveTextContaining([
580+
'browser and mobile automation test framework',
581+
'Started'
582+
])
583+
// 👍 supported starting with v9
584+
await expect(elem).toHaveText(
585+
expect.stringContaining('browser and mobile automation test framework'))
586+
await expect(elem).toHaveText([
587+
expect.stringContaining('browser and mobile automation test framework'),
588+
expect.stringContaining('Started')
589+
])
514590
```
515591

516592
### toHaveHTML
@@ -531,14 +607,35 @@ await expect(elem).toHaveHTML(['Next-gen browser and mobile automation test fram
531607

532608
Checks if element contains a specific text. Can also be called with an array as parameter in the case where the element can have different texts.
533609

610+
__Deprecated:__ please use `expect.stringContaining()` instead!
611+
534612
##### Usage
535613

536614
```js
537615
await browser.url('https://webdriver.io/')
538616
const elem = await $('.hero__subtitle')
617+
618+
// 👎 deprecated
539619
await expect(elem).toHaveHTMLContaining('Next-gen browser')
540-
await expect(elem).toHaveHTMLContaining('Next-gen browser', { includeSelectorTag: false })
541-
await expect(elem).toHaveHTMLContaining(['Next-gen browser', 'Get Started'], { includeSelectorTag: false })
620+
await expect(elem).toHaveHTMLContaining(
621+
'Next-gen browser',
622+
{ includeSelectorTag: false }
623+
)
624+
await expect(elem).toHaveHTMLContaining([
625+
'Next-gen browser',
626+
'Get Started'
627+
], { includeSelectorTag: false })
628+
// 👍 supported starting with v9
629+
await expect(elem).toHaveHTMLContaining(
630+
expect.stringContaining('Next-gen browser'))
631+
await expect(elem).toHaveHTMLContaining(
632+
expect.stringContaining('Next-gen browser'),
633+
{ includeSelectorTag: false }
634+
)
635+
await expect(elem).toHaveHTMLContaining([
636+
expect.stringContaining('Next-gen browser'),
637+
expect.stringContaining('Get Started')
638+
], { includeSelectorTag: false })
542639
```
543640

544641
### toBeDisplayedInViewport

0 commit comments

Comments
 (0)