Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: specify assertion timeout type (#23333)

Browse source 
Fixes https://github.com/microsoft/playwright-dotnet/issues/2589
This commit is contained in:
Max Schmitt 2023-05-30 18:13:14 +02:00 committed by GitHub
parent 0c2ec4b7f6
commit d6e24fafe8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/src/api/params.md
View file

@ -829,13 +829,13 @@ using the [`method: AndroidDevice.setDefaultTimeout`] method.
* langs: js * langs: js
- `timeout` <[float]> - `timeout` <[float]>
Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
## csharp-java-python-assertions-timeout ## csharp-java-python-assertions-timeout
* langs: java, python, csharp * langs: java, python, csharp
- `timeout` <[float]> - `timeout` <[float]>
Time to retry the assertion for. Time to retry the assertion for in milliseconds. Defaults to `5000`.
## assertions-max-diff-pixels ## assertions-max-diff-pixels
* langs: js * langs: js

52
packages/playwright-test/types/test.d.ts vendored
View file

@ -4869,7 +4869,7 @@ interface LocatorAssertions {
attached?: boolean; attached?: boolean;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -4890,7 +4890,7 @@ interface LocatorAssertions {
checked?: boolean; checked?: boolean;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -4913,7 +4913,7 @@ interface LocatorAssertions {
*/ */
toBeDisabled(options?: { toBeDisabled(options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -4934,7 +4934,7 @@ interface LocatorAssertions {
editable?: boolean; editable?: boolean;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -4953,7 +4953,7 @@ interface LocatorAssertions {
*/ */
toBeEmpty(options?: { toBeEmpty(options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -4974,7 +4974,7 @@ interface LocatorAssertions {
enabled?: boolean; enabled?: boolean;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -4993,7 +4993,7 @@ interface LocatorAssertions {
*/ */
toBeFocused(options?: { toBeFocused(options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5013,7 +5013,7 @@ interface LocatorAssertions {
*/ */
toBeHidden(options?: { toBeHidden(options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5044,7 +5044,7 @@ interface LocatorAssertions {
ratio?: number; ratio?: number;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5063,7 +5063,7 @@ interface LocatorAssertions {
*/ */
toBeVisible(options?: { toBeVisible(options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
@ -5125,7 +5125,7 @@ interface LocatorAssertions {
ignoreCase?: boolean; ignoreCase?: boolean;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
@ -5151,7 +5151,7 @@ interface LocatorAssertions {
*/ */
toHaveAttribute(name: string, value: string|RegExp, options?: { toHaveAttribute(name: string, value: string|RegExp, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5184,7 +5184,7 @@ interface LocatorAssertions {
*/ */
toHaveClass(expected: string|RegExp|Array<string|RegExp>, options?: { toHaveClass(expected: string|RegExp|Array<string|RegExp>, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5204,7 +5204,7 @@ interface LocatorAssertions {
*/ */
toHaveCount(count: number, options?: { toHaveCount(count: number, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5225,7 +5225,7 @@ interface LocatorAssertions {
*/ */
toHaveCSS(name: string, value: string|RegExp, options?: { toHaveCSS(name: string, value: string|RegExp, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5245,7 +5245,7 @@ interface LocatorAssertions {
*/ */
toHaveId(id: string|RegExp, options?: { toHaveId(id: string|RegExp, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5267,7 +5267,7 @@ interface LocatorAssertions {
*/ */
toHaveJSProperty(name: string, value: any, options?: { toHaveJSProperty(name: string, value: any, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5345,7 +5345,7 @@ interface LocatorAssertions {
threshold?: number; threshold?: number;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5422,7 +5422,7 @@ interface LocatorAssertions {
threshold?: number; threshold?: number;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5481,7 +5481,7 @@ interface LocatorAssertions {
ignoreCase?: boolean; ignoreCase?: boolean;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
@ -5507,7 +5507,7 @@ interface LocatorAssertions {
*/ */
toHaveValue(value: string|RegExp, options?: { toHaveValue(value: string|RegExp, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5539,7 +5539,7 @@ interface LocatorAssertions {
*/ */
toHaveValues(values: Array<string|RegExp>, options?: { toHaveValues(values: Array<string|RegExp>, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5675,7 +5675,7 @@ interface PageAssertions {
threshold?: number; threshold?: number;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5782,7 +5782,7 @@ interface PageAssertions {
threshold?: number; threshold?: number;
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5801,7 +5801,7 @@ interface PageAssertions {
*/ */
toHaveTitle(titleOrRegExp: string|RegExp, options?: { toHaveTitle(titleOrRegExp: string|RegExp, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;
@ -5820,7 +5820,7 @@ interface PageAssertions {
*/ */
toHaveURL(urlOrRegExp: string|RegExp, options?: { toHaveURL(urlOrRegExp: string|RegExp, options?: {
/** /**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`. * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
*/ */
timeout?: number; timeout?: number;
}): Promise<void>; }): Promise<void>;