Skip to content

Commit cd25797

Browse files
committed
docs: add inline documentation for configure
1 parent 36c23dc commit cd25797

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

lib/index.ts

+13
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,19 @@ export function wait(
176176

177177
export const waitFor = wait
178178

179+
/**
180+
* Configuration API for legacy queries that return `ElementHandle` instances.
181+
* Only `testIdAttribute` and `asyncUtilTimeout` are currently supported.
182+
183+
* @see {@link https://testing-library.com/docs/dom-testing-library/api-configuration}
184+
*
185+
* ⚠️ This API has no effect on the queries that return `Locator` instances. Use
186+
* `test.use` instead to configure the `Locator` queries.
187+
*
188+
* @see {@link https://github.com/testing-library/playwright-testing-library/releases/tag/v4.4.0-beta.2}
189+
*
190+
* @param config
191+
*/
179192
export function configure(config: Partial<Config>): void {
180193
if (!config) {
181194
return

0 commit comments

Comments
 (0)