yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: hide unsupported expect methods (#12403)

Browse Source
This commit is contained in:
Max Schmitt 2022-03-01 20:04:34 +01:00 committed by GitHub
parent 96945ab0a2
commit 5b7db90cb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
packages/playwright-test/types/testExpect.d.ts vendored
View File

@ -31,19 +31,21 @@ export declare type Expect = {
<T = unknown>(actual: T, message?: string): MakeMatchers<T>; <T = unknown>(actual: T, message?: string): MakeMatchers<T>;
soft: <T = unknown>(actual: T, message?: string) => MakeMatchers<T>; soft: <T = unknown>(actual: T, message?: string) => MakeMatchers<T>;
// Sourced from node_modules/expect/build/types.d.ts
assertions(arg0: number): void;
extend(arg0: any): void; extend(arg0: any): void;
extractExpectedAssertionsErrors: typeof expect['extractExpectedAssertionsErrors'];
getState(): expect.MatcherState; getState(): expect.MatcherState;
hasAssertions(): void;
setState(state: Partial<expect.MatcherState>): void; setState(state: Partial<expect.MatcherState>): void;
any(expectedObject: any): AsymmetricMatcher;
anything(): AsymmetricMatcher;
arrayContaining(sample: Array<unknown>): AsymmetricMatcher; arrayContaining(sample: Array<unknown>): AsymmetricMatcher;
objectContaining(sample: Record<string, unknown>): AsymmetricMatcher; objectContaining(sample: Record<string, unknown>): AsymmetricMatcher;
stringContaining(expected: string): AsymmetricMatcher; stringContaining(expected: string): AsymmetricMatcher;
stringMatching(expected: string | RegExp): AsymmetricMatcher; stringMatching(expected: string | RegExp): AsymmetricMatcher;
/**
* Removed following methods because they rely on a test-runner integration from Jest which we don't support:
* - assertions()
* - extractExpectedAssertionsErrors()
* – hasAssertions()
* - any()
* - anything()
*/
}; };
type ImageComparatorOptions = { type ImageComparatorOptions = {
@ -54,18 +56,59 @@ type ImageComparatorOptions = {
type Awaited<T> = T extends PromiseLike<infer U> ? U : T; type Awaited<T> = T extends PromiseLike<infer U> ? U : T;
type OverriddenExpectProperties = /**
'not' | * Removed methods require the jest.fn() integration from Jest to spy on function calls which we don't support:
'resolves' | * - lastCalledWith()
'rejects' | * - lastReturnedWith()
'toMatchInlineSnapshot' | * - nthCalledWith()
'toThrowErrorMatchingInlineSnapshot' | * - nthReturnedWith()
'toMatchSnapshot' | * - toBeCalled()
'toThrowErrorMatchingSnapshot'; * - toBeCalledTimes()
* - toBeCalledWith()
* - toHaveBeenCalled()
* - toHaveBeenCalledTimes()
* - toHaveBeenCalledWith()
* - toHaveBeenLastCalledWith()
* - toHaveBeenNthCalledWith()
* - toHaveLastReturnedWith()
* - toHaveNthReturnedWith()
* - toHaveReturned()
* - toHaveReturnedTimes()
* - toHaveReturnedWith()
* - toReturn()
* - toReturnTimes()
* - toReturnWith()
* - toThrowErrorMatchingSnapshot()
* - toThrowErrorMatchingInlineSnapshot()
*/
type SupportedExpectProperties =
'toBe' |
'toBeCloseTo' |
'toBeDefined' |
'toBeFalsy' |
'toBeGreaterThan' |
'toBeGreaterThanOrEqual' |
'toBeInstanceOf' |
'toBeLessThan' |
'toBeLessThanOrEqual' |
'toBeNaN' |
'toBeNull' |
'toBeTruthy' |
'toBeUndefined' |
'toContain' |
'toContainEqual' |
'toEqual' |
'toHaveLength' |
'toHaveProperty' |
'toMatch' |
'toMatchObject' |
'toStrictEqual' |
'toThrow' |
'toThrowError'
declare global { declare global {
export namespace PlaywrightTest { export namespace PlaywrightTest {
export interface Matchers<R> extends Omit<expect.Matchers<R>, OverriddenExpectProperties> { export interface Matchers<R> extends Pick<expect.Matchers<R>, SupportedExpectProperties> {
/** /**
* If you know how to test something, `.not` lets you test its opposite. * If you know how to test something, `.not` lets you test its opposite.
*/ */