run

Creates a new runner instance with the specified properties.

Signature

run(props: IAutoscroll): Promise<IAutoscrollRunner>

Parameters

Name	Type	Optional	Description
props	IAutoscroll	No	Specifies the runner properties.

Return value

Returns a promise to the IAutoscrollRunner controller reference of the runner. This controller reference can be used to control (start, stop, pause, etc.) the runner.

Example

import { run } from "@tripetto/runner-autoscroll";

// Open the runner
run({
  definition: /* Supply your form definition here */
});

// Retrieve a reference to the runner using async await
const runner = await run({
  definition: /* Supply your form definition here */
});

// Or use the promise
run({
  definition: /* Supply your form definition here */
}).then((runner) => {
  // Do something with the runner here
});