Skip to content

Lupa API Reference / commands/locator / CheckOptions

Interface: CheckOptions

Defined in: src/commands/locator.ts:261

Options for the check action.

Extends

Properties

force?

optional force?: boolean

Defined in: src/commands/locator.ts:171

Whether to bypass the actionability checks. Defaults to false.

Inherited from

ForceOption.force


position?

optional position?: object

Defined in: src/commands/locator.ts:216

A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

x

x: number

X coordinate

y

y: number

Y coordinate

Inherited from

PositionOption.position


strict?

optional strict?: boolean

Defined in: src/commands/locator.ts:182

When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

Inherited from

StrictOption.strict


timeout?

optional timeout?: number

Defined in: src/commands/locator.ts:161

Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

Inherited from

TimeoutOption.timeout


trial?

optional trial?: boolean

Defined in: src/commands/locator.ts:193

When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

Inherited from

TrialOption.trial