@serenity-js/web 3.24.1 → 3.25.1

package/lib/screenplay/abilities/BrowseTheWeb.js

@@ -3,22 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BrowseTheWeb = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * The {@apilink Ability|ability} to `BrowseTheWeb` enables an {@apilink Actor|actor}
- * to {@apilink Interaction|interact with} and {@apilink Question|retrieve information from} Web-based user interfaces.
+ * The [ability](https://serenity-js.org/api/core/class/Ability/) to `BrowseTheWeb` enables an [actor](https://serenity-js.org/api/core/class/Actor/)
+ * to [interact with](https://serenity-js.org/api/core/class/Interaction/) and [retrieve information from](https://serenity-js.org/api/core/class/Question/) Web-based user interfaces.
  *
- * `BrowseTheWeb` wraps test integration tools such as [Playwright](/api/playwright),
- * [Protractor](/api/protractor), or [WebdriverIO](/api/webdriverio),
- * and together with Serenity/JS Web models, such as {@apilink Page} or {@apilink PageElement} - offers a standardised way
+ * `BrowseTheWeb` wraps test integration tools such as [Playwright](https://serenity-js.org/api/playwright),
+ * [Protractor](https://serenity-js.org/api/protractor), or [WebdriverIO](https://serenity-js.org/api/webdriverio),
+ * and together with Serenity/JS Web models, such as [`Page`](https://serenity-js.org/api/web/class/Page/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) - offers a standardised way
  * to write Web-based tests following the Screenplay Pattern.
  *
- * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](/api/web)
+ * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](https://serenity-js.org/api/web)
  * also helps to make your tests portable across the various test integration tools and helps to make your test
  * code easier to reuse across projects and teams.
  *
  * ## Giving the actors an ability to `BrowseTheWeb`
  *
- * To give an {@apilink Actor|actor} an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
- * via {@apilink Actor.whoCan} in {@apilink Cast.prepare}, or via {@apilink Cast.where}.
+ * To give an [actor](https://serenity-js.org/api/core/class/Actor/) an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
+ * via [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan) in [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare), or via [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where).
  *
  * ```ts
  * import { beforeEach } from 'mocha'
@@ -39,21 +39,23 @@ const core_1 = require("@serenity-js/core");
  *
  * To learn more about using Serenity/JS with your chosen test integration tool, follow their respective documentation:
  *
- * - {@apilink BrowseTheWebWithPlaywright}
- * - {@apilink BrowseTheWebWithProtractor}
- * - {@apilink BrowseTheWebWithWebdriverIO}
+ * - [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * - [`BrowseTheWebWithProtractor`](https://serenity-js.org/api/protractor/class/BrowseTheWebWithProtractor/)
+ * - [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/)
  *
  * ## Using the ability to `BrowseTheWeb`
  *
- * To use the ability to `BrowseTheWeb` in a custom {@apilink Interaction} or {@apilink Question}, use the **generic** method {@apilink BrowseTheWeb.as}
+ * To use the ability to `BrowseTheWeb` in a custom [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+ * or [`Question`](https://serenity-js.org/api/core/class/Question/), use the **generic** method [`BrowseTheWeb.as`](https://serenity-js.org/api/core/class/Ability/#as)
  * to retrieve it.
  *
- * This generic method retrieves the integration tool-specific implementation of {@apilink BrowseTheWeb} present on the {@apilink Actor},
- * such as {@apilink BrowseTheWebWithPlaywright} or {@apilink BrowseTheWebWethWebdriverIO}, using {@apilink Actor.abilityTo}.
+ * This generic method retrieves the integration tool-specific implementation of [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) present on the [`Actor`](https://serenity-js.org/api/core/class/Actor/),
+ * such as [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * or [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/), using [`Actor.abilityTo`](https://serenity-js.org/api/core/class/Actor/#abilityTo).
  *
  * This decoupling mechanism helps to make your test code portable across test integration tools,
  * since the only part of your test suite that needs to know about the test integration tool used are the actors.
- * The rest of your test code, so {@apilink Task|tasks}, {@apilink Interaction|interactions}, and {@apilink Question|questions},
+ * The rest of your test code, so [tasks](https://serenity-js.org/api/core/class/Task/), [interactions](https://serenity-js.org/api/core/class/Interaction/), and [questions](https://serenity-js.org/api/core/class/Question/),
  * remain fully agnostic of the underlying tool.
  *
  * ```ts
@@ -71,10 +73,10 @@ const core_1 = require("@serenity-js/core");
  *
  * ### Learn more
  *
- * - {@apilink Ability}
- * - {@apilink Actor.whoCan}
- * - {@apilink Cast.where}
- * - {@apilink Cast.prepare}
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan)
+ * - [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where)
+ * - [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare)
  *
  * @group Abilities
  */
@@ -85,20 +87,20 @@ class BrowseTheWeb extends core_1.Ability {
         this.session = session;
     }
     /**
-     * Returns a {@apilink Page} representing the currently active browser tab.
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active browser tab.
      */
     async currentPage() {
         return this.session.currentPage();
     }
     /**
-     * Returns an array of {@apilink Page|pages} representing all the browser tabs
-     * available in the current {@apilink BrowsingSession}.
+     * Returns an array of [pages](https://serenity-js.org/api/web/class/Page/) representing all the browser tabs
+     * available in the current [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
      */
     allPages() {
         return this.session.allPages();
     }
     /**
-     * Returns {@apilink BrowserCapabilities|basic meta-data} about the browser associated with this ability.
+     * Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the browser associated with this ability.
      */
     async browserCapabilities() {
         return this.session.browserCapabilities();

package/lib/screenplay/abilities/BrowseTheWeb.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowseTheWeb.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWeb.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAsB,YAAwC,SAAQ,cAAO;IAE1C;IAA/B,YAA+B,OAAmD;QAC9E,KAAK,EAAE,CAAC;QADmB,YAAO,GAAP,OAAO,CAA4C;IAElF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAC9C,CAAC;CACJ;AA3BD,oCA2BC"}
+{"version":3,"file":"BrowseTheWeb.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWeb.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AACH,MAAsB,YAAwC,SAAQ,cAAO;IAE1C;IAA/B,YAA+B,OAAmD;QAC9E,KAAK,EAAE,CAAC;QADmB,YAAO,GAAP,OAAO,CAA4C;IAElF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAC9C,CAAC;CACJ;AA3BD,oCA2BC"}

package/lib/screenplay/interactions/Clear.d.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@
 import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to clear the `value` of a [form `input` field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
  *
  * ## Example widget
@@ -45,18 +45,18 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Enter}
- * - {@apilink Value}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Enter`](https://serenity-js.org/api/web/class/Enter/)
+ * - [`Value`](https://serenity-js.org/api/web/class/Value/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export declare class Clear extends PageElementInteraction {
     private readonly field;
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to clear the value of an input `field`,
      *
      * @param field

package/lib/screenplay/interactions/Clear.js

@@ -4,7 +4,7 @@ exports.Clear = void 0;
 const core_1 = require("@serenity-js/core");
 const PageElementInteraction_1 = require("./PageElementInteraction");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to clear the `value` of a [form `input` field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
  *
  * ## Example widget
@@ -47,18 +47,18 @@ const PageElementInteraction_1 = require("./PageElementInteraction");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Enter}
- * - {@apilink Value}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Enter`](https://serenity-js.org/api/web/class/Enter/)
+ * - [`Value`](https://serenity-js.org/api/web/class/Value/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 class Clear extends PageElementInteraction_1.PageElementInteraction {
     field;
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to clear the value of an input `field`,
      *
      * @param field

package/lib/screenplay/interactions/Click.d.ts

@@ -2,8 +2,8 @@ import type { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@
 import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to scroll the given {@apilink PageElement} into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to scroll the given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
  *
  * ## Example widget
  *
@@ -41,15 +41,15 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export declare class Click extends PageElementInteraction {
     private readonly element;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be clicked on

package/lib/screenplay/interactions/Click.js

@@ -4,8 +4,8 @@ exports.Click = void 0;
 const core_1 = require("@serenity-js/core");
 const PageElementInteraction_1 = require("./PageElementInteraction");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to scroll the given {@apilink PageElement} into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to scroll the given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
  *
  * ## Example widget
  *
@@ -43,15 +43,15 @@ const PageElementInteraction_1 = require("./PageElementInteraction");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 class Click extends PageElementInteraction_1.PageElementInteraction {
     element;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be clicked on

package/lib/screenplay/interactions/DoubleClick.d.ts

@@ -2,8 +2,8 @@ import type { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@
 import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to perform a double click on a given {@apilink PageElement}.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to perform a double click on a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  * ```html
@@ -64,15 +64,15 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export declare class DoubleClick extends PageElementInteraction {
     private readonly pageElement;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be double-clicked on

package/lib/screenplay/interactions/DoubleClick.js

@@ -4,8 +4,8 @@ exports.DoubleClick = void 0;
 const core_1 = require("@serenity-js/core");
 const PageElementInteraction_1 = require("./PageElementInteraction");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to perform a double click on a given {@apilink PageElement}.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to perform a double click on a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  * ```html
@@ -66,15 +66,15 @@ const PageElementInteraction_1 = require("./PageElementInteraction");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 class DoubleClick extends PageElementInteraction_1.PageElementInteraction {
     pageElement;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be double-clicked on

package/lib/screenplay/interactions/Enter.d.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@
 import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
  *
  * ## Example widget
@@ -39,7 +39,7 @@ import { PageElementInteraction } from './PageElementInteraction';
  * ## Handling sensitive information
  *
  * By design, any data handled by an actor appears in Serenity/JS reports.
- * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
  *
  * ```ts
  * import { actorCalled, Masked } from '@serenity-js/core'
@@ -55,8 +55,8 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
@@ -64,7 +64,7 @@ export declare class Enter extends PageElementInteraction {
     private readonly values;
     private readonly field;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param values
      *  The text value to be entered

package/lib/screenplay/interactions/Enter.js

@@ -5,7 +5,7 @@ const core_1 = require("@serenity-js/core");
 const io_1 = require("@serenity-js/core/lib/io");
 const PageElementInteraction_1 = require("./PageElementInteraction");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
  *
  * ## Example widget
@@ -42,7 +42,7 @@ const PageElementInteraction_1 = require("./PageElementInteraction");
  * ## Handling sensitive information
  *
  * By design, any data handled by an actor appears in Serenity/JS reports.
- * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
  *
  * ```ts
  * import { actorCalled, Masked } from '@serenity-js/core'
@@ -58,8 +58,8 @@ const PageElementInteraction_1 = require("./PageElementInteraction");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
@@ -67,7 +67,7 @@ class Enter extends PageElementInteraction_1.PageElementInteraction {
     values;
     field;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param values
      *  The text value to be entered

package/lib/screenplay/interactions/ExecuteScript.d.ts

@@ -1,19 +1,19 @@
 import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } from '@serenity-js/core';
 import { Interaction } from '@serenity-js/core';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to inject a script into the browser and execute it in the context of the current browser tab.
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink LastScriptExecution.result}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result)
  *
  * @group Activities
  */
 export declare class ExecuteScript {
     /**
-     * Instantiates a version of this {@apilink Interaction}
+     * Instantiates a version of this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
      * configured to load a script from `sourceUrl`.
      *
      * @param sourceUrl
@@ -21,7 +21,7 @@ export declare class ExecuteScript {
      */
     static from(sourceUrl: Answerable<string>): Interaction;
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to execute an asynchronous script within the context of the current browser tab.
      *
      * The script fragment will be executed as the body of an anonymous function.
@@ -30,20 +30,20 @@ export declare class ExecuteScript {
      *
      * Any arguments provided in addition to the script will be included as script arguments and may be referenced
      * using the `arguments` object. Arguments may be a `boolean`, `number`, `string`
-     * or {@apilink PageElement}.
+     * or [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      * Arrays and objects may also be used as script arguments as long as each item adheres
      * to the types previously mentioned.
      *
-     * Unlike executing synchronous JavaScript with {@apilink ExecuteScript.sync},
+     * Unlike executing synchronous JavaScript with [`ExecuteScript.sync`](https://serenity-js.org/api/web/class/ExecuteScript/#sync),
      * scripts executed with this function must explicitly signal they are finished by invoking the provided callback.
      *
      * This callback will always be injected into the executed function as the last argument,
      * and thus may be referenced with `arguments[arguments.length - 1]`.
      *
      * If the script invokes the `callback` with a return value, this will be made available
-     * via the {@apilink LastScriptExecution.result}.
+     * via the [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result).
      *
-     * **Please note** that in order to signal an error in the `script` you need to throw an {@apilink Error}
+     * **Please note** that in order to signal an error in the `script` you need to throw an [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)
      * instead of passing it to the callback function.
      *
      * #### Executing an async script
@@ -102,7 +102,7 @@ export declare class ExecuteScript {
      *
      * #### Passing PageElement arguments to an async script
      *
-     * Serenity/JS automatically converts {@link PageElement} objects passed as arguments to the script
+     * Serenity/JS automatically converts [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects passed as arguments to the script
      * into their corresponding DOM elements.
      *
      * ```ts
@@ -126,7 +126,7 @@ export declare class ExecuteScript {
      *
      * #### Using nested data structures containing PageElement objects
      *
-     * Serenity/JS automatically converts any {@link PageElement} objects
+     * Serenity/JS automatically converts any [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects
      * contained in nested data structures passed to the script
      * into their corresponding DOM elements.
      *
@@ -156,17 +156,17 @@ export declare class ExecuteScript {
      * ```
      *
      * #### Learn more
-     * - {@apilink LastScriptExecution.result}
+     * - [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result)
      *
      * @param script
      *  The script to be executed
      */
     static async(script: string | Function): ExecuteScriptWithArguments;
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to execute a synchronous script within the context of the current browser tab.
      *
-     * If the script returns a value, it will be made available via {@apilink LastScriptExecution.result}.
+     * If the script returns a value, it will be made available via [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result).
      *
      * #### Executing a sync script as string and reading the result
      *
@@ -214,7 +214,7 @@ export declare class ExecuteScript {
      *
      * #### Passing PageElement arguments to a sync script
      *
-     * Serenity/JS automatically converts {@link PageElement} objects passed as arguments to the script
+     * Serenity/JS automatically converts [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects passed as arguments to the script
      * into their corresponding DOM elements.
      *
      * ```ts
@@ -235,7 +235,7 @@ export declare class ExecuteScript {
      *
      * #### Using nested data structures containing PageElement objects
      *
-     * Serenity/JS automatically converts any {@link PageElement} objects
+     * Serenity/JS automatically converts any [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects
      * contained in nested data structures passed to the script
      * into their corresponding DOM elements.
      *
@@ -262,7 +262,7 @@ export declare class ExecuteScript {
      * ```
      *
      * #### Learn more
-     * - {@apilink LastScriptExecution.result}
+     * - [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result)
      *
      * @param script
      *  The script to be executed
@@ -273,7 +273,7 @@ export declare class ExecuteScript {
  * Allows for a script to be executed to be parametrised.
  *
  * ## Learn more
- * -  {@apilink ExecuteScript}
+ * -  [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/)
  *
  * @group Activities
  */
@@ -283,7 +283,7 @@ export declare abstract class ExecuteScriptWithArguments extends Interaction {
     constructor(description: Answerable<string>, script: string | Function, // eslint-disable-line @typescript-eslint/ban-types
     args?: Array<Answerable<any>>);
     /**
-     * Instantiates this {@apilink Interaction}
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
      *
      * @param args
      *  Arguments to parametrise the script with