Skip to main content
Version: 1.x

Type Alias: MatcherCheckFn<TArgs>

MatcherCheckFn<TArgs> = (page, controlId, ...args) => Promise<PollableMatcherResult>

A raw check function that evaluates a UI5 control assertion without retry.

Type Parameters​

TArgs​

TArgs extends readonly unknown[] = readonly unknown[]

Tuple of additional arguments after (page, controlId).

Parameters​

page​

MatcherPage

controlId​

string

args​

...TArgs

Returns​

Promise<PollableMatcherResult>

Remarks​

This is the function shape users provide to createUI5Matcher. It receives the page, control ID, and any number of additional arguments, and returns a single-shot PollableMatcherResult.

Example​

const checkFn: MatcherCheckFn<[string]> = async (page, controlId, expected) => {
const actual = await getControlProperty(page, controlId, 'icon');
return { pass: actual === expected, message: () => '...' };
};