DocsWorkflowsComponentsMachinemachine:extension:advance

machine:extension:advance

Acts on the control that reaches a listing's next batch. The pipeline owns the repetition, so this takes one step towards the next page and returns. Whether there is a page after that is answered by observing again, which is the workflow document's turn rather than this component's.

Options

Name	Type	Description
`pagination`	`ObservedPagination`	The control an observation reported, which is what machine:extension:observe returns
↳ `kind`	`string`	Is the shape the page uses to reach its next batch, one of link, numbered, more, or infinite.
↳ `selector`	`string`	Targets the control that advances the listing.
↳ `label`	`string`	Is the control's visible text.
↳ `url`	`string`	Is the next page's href when the control is a link.
↳ `pages`	`int`	Counts the numbered page links a pager prints, when it prints any.
`match_url`	`string`	A substring the listing's tab carries, so the step acts on the tab the observation read
`client_id`	`string`	The extension client to act through, a hint the host may honour; empty leaves the choice of browser to the host
`settle`	`string`	The CSS selector to wait for once the control has been acted on, normally the listing's item container
`timeout_ms`	`int`	How long to wait for the browser before failing the step

Outputs

Name	Type	Description
`moved`	`bool`	Whether the control was acted on, false when the page reported none
`kind`	`string`	The shape of the control that was acted on
`url`	`string`	The address the step navigated to, empty when it clicked or scrolled instead
`match_url`	`string`	The substring the next observation should find the tab by, unchanged from what came in because a listing's later pages rarely share the second page's path

Edit or read the source on GitHub