playwright/types/testExpect.d.ts

171 lines
5.3 KiB
TypeScript
Raw Normal View History

/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
* Modifications copyright (c) Microsoft Corporation.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import type * as expect from 'expect';
import type { ExpectedAssertionsErrors } from 'expect/build/types';
export declare type AsymmetricMatcher = Record<string, any>;
export declare type Expect = {
<T = unknown>(actual: T): PlaywrightTest.Matchers<T>;
// Sourced from node_modules/expect/build/types.d.ts
assertions(arg0: number): void;
extend(arg0: any): void;
extractExpectedAssertionsErrors: () => ExpectedAssertionsErrors;
getState(): expect.MatcherState;
hasAssertions(): void;
setState(state: Partial<expect.MatcherState>): void;
any(expectedObject: any): AsymmetricMatcher;
anything(): AsymmetricMatcher;
arrayContaining(sample: Array<unknown>): AsymmetricMatcher;
objectContaining(sample: Record<string, unknown>): AsymmetricMatcher;
stringContaining(expected: string): AsymmetricMatcher;
stringMatching(expected: string | RegExp): AsymmetricMatcher;
};
type OverriddenExpectProperties =
'not' |
'resolves' |
'rejects' |
'toMatchInlineSnapshot' |
'toThrowErrorMatchingInlineSnapshot' |
'toMatchSnapshot' |
'toThrowErrorMatchingSnapshot';
declare global {
export namespace PlaywrightTest {
export interface Matchers<R> extends Omit<expect.Matchers<R>, OverriddenExpectProperties> {
/**
* If you know how to test something, `.not` lets you test its opposite.
*/
not: PlaywrightTest.Matchers<R>;
/**
* Use resolves to unwrap the value of a fulfilled promise so any other
* matcher can be chained. If the promise is rejected the assertion fails.
*/
resolves: PlaywrightTest.Matchers<Promise<R>>;
/**
* Unwraps the reason of a rejected promise so any other matcher can be chained.
* If the promise is fulfilled the assertion fails.
*/
rejects: PlaywrightTest.Matchers<Promise<R>>;
/**
* Match snapshot
*/
toMatchSnapshot(options: {
name: string,
threshold?: number
}): R;
/**
* Match snapshot
*/
toMatchSnapshot(name: string, options?: {
threshold?: number
}): R;
/**
2021-07-29 08:30:37 +03:00
* Asserts input is checked.
*/
2021-07-29 08:30:37 +03:00
toBeChecked(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts input is disabled.
*/
2021-07-29 08:30:37 +03:00
toBeDisabled(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts input is editable.
*/
2021-07-29 08:30:37 +03:00
toBeEditable(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts given DOM node or input has no text content or no input value.
*/
2021-07-29 08:30:37 +03:00
toBeEmpty(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts input is enabled.
*/
2021-07-29 08:30:37 +03:00
toBeEnabled(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts given DOM is a focused (active) in document.
*/
2021-07-29 08:30:37 +03:00
toBeFocused(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts given DOM node is hidden or detached from DOM.
*/
2021-07-29 08:30:37 +03:00
toBeHidden(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts given DOM node visible on the screen.
*/
2021-07-29 08:30:37 +03:00
toBeVisible(options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts element's text content matches given pattern or contains given substring.
*/
2021-07-29 08:30:37 +03:00
toContainText(expected: string, options?: { timeout?: number, useInnerText?: boolean }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts element's attributes `name` matches expected value.
*/
toHaveAttribute(name: string, expected: string | RegExp, options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts that DOM node has a given CSS class.
*/
toHaveClass(className: string | RegExp | (string|RegExp)[], options?: { timeout?: number }): Promise<R>;
/**
* Asserts number of DOM nodes matching given locator.
*/
toHaveCount(expected: number, options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts element's computed CSS property `name` matches expected value.
*/
2021-07-29 08:30:37 +03:00
toHaveCSS(expected: string | RegExp, name: string, options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts element's `id` attribute matches expected value.
*/
2021-07-29 08:30:37 +03:00
toHaveId(expected: string | RegExp, options?: { timeout?: number }): Promise<R>;
/**
* Asserts JavaScript object that corresponds to the Node has a property with given value.
*/
toHaveJSProperty(name: string, value: any, options?: { timeout?: number }): Promise<R>;
/**
* Asserts element's text content.
*/
toHaveText(expected: string | RegExp | (string|RegExp)[], options?: { timeout?: number, useInnerText?: boolean }): Promise<R>;
2021-07-29 08:30:37 +03:00
/**
* Asserts page's title.
*/
toHaveTitle(expected: string | RegExp, options?: { timeout?: number }): Promise<R>;
/**
* Asserts page's URL.
*/
toHaveURL(expected: string | RegExp, options?: { timeout?: number }): Promise<R>;
/**
2021-07-29 08:30:37 +03:00
* Asserts input element's value.
*/
toHaveValue(expected: string | RegExp, options?: { timeout?: number }): Promise<R>;
}
}
}
export { };