@serenity-js/core 3.25.0 → 3.25.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (268) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +1 -1
  3. package/lib/Serenity.d.ts +22 -22
  4. package/lib/Serenity.js +22 -22
  5. package/lib/adapter/OutputStream.d.ts +5 -4
  6. package/lib/adapter/OutputStream.d.ts.map +1 -1
  7. package/lib/adapter/TestRunnerAdapter.d.ts +2 -2
  8. package/lib/config/ClassDescription.d.ts +1 -1
  9. package/lib/config/SerenityConfig.d.ts +22 -20
  10. package/lib/config/SerenityConfig.d.ts.map +1 -1
  11. package/lib/config/SerenityConfig.js +22 -20
  12. package/lib/config/SerenityConfig.js.map +1 -1
  13. package/lib/errors/ErrorFactory.d.ts +2 -1
  14. package/lib/errors/ErrorFactory.d.ts.map +1 -1
  15. package/lib/errors/ErrorFactory.js +2 -1
  16. package/lib/errors/ErrorFactory.js.map +1 -1
  17. package/lib/errors/RaiseErrors.d.ts +9 -9
  18. package/lib/errors/RaiseErrors.js +9 -9
  19. package/lib/errors/diff/AnsiDiffFormatter.d.ts +1 -1
  20. package/lib/errors/diff/AnsiDiffFormatter.js +1 -1
  21. package/lib/errors/diff/DiffFormatter.d.ts +1 -1
  22. package/lib/errors/diff/NoOpDiffFormatter.d.ts +1 -1
  23. package/lib/errors/diff/NoOpDiffFormatter.js +1 -1
  24. package/lib/errors/model/AssertionError.d.ts +1 -1
  25. package/lib/errors/model/AssertionError.js +1 -1
  26. package/lib/errors/model/ConfigurationError.d.ts +1 -1
  27. package/lib/errors/model/ConfigurationError.js +1 -1
  28. package/lib/errors/model/ImplementationPendingError.d.ts +3 -3
  29. package/lib/errors/model/ImplementationPendingError.js +3 -3
  30. package/lib/errors/model/ListItemNotFoundError.d.ts +2 -2
  31. package/lib/errors/model/ListItemNotFoundError.js +2 -2
  32. package/lib/errors/model/LogicError.d.ts +2 -2
  33. package/lib/errors/model/LogicError.js +2 -2
  34. package/lib/errors/model/OperationInterruptedError.d.ts +2 -2
  35. package/lib/errors/model/OperationInterruptedError.js +2 -2
  36. package/lib/errors/model/RuntimeError.d.ts +2 -2
  37. package/lib/errors/model/RuntimeError.js +2 -2
  38. package/lib/errors/model/TestCompromisedError.d.ts +1 -1
  39. package/lib/errors/model/TestCompromisedError.js +1 -1
  40. package/lib/errors/model/TimeoutExpiredError.d.ts +2 -2
  41. package/lib/errors/model/TimeoutExpiredError.js +2 -2
  42. package/lib/errors/model/UnknownError.d.ts +1 -1
  43. package/lib/errors/model/UnknownError.js +1 -1
  44. package/lib/events/ActivityFinished.d.ts +1 -1
  45. package/lib/events/ActivityFinished.js +1 -1
  46. package/lib/events/ActivityStarts.d.ts +1 -1
  47. package/lib/events/ActivityStarts.js +1 -1
  48. package/lib/events/BusinessRuleDetected.d.ts +1 -1
  49. package/lib/events/BusinessRuleDetected.js +1 -1
  50. package/lib/events/SceneFinishes.d.ts +2 -1
  51. package/lib/events/SceneFinishes.d.ts.map +1 -1
  52. package/lib/events/SceneFinishes.js +2 -1
  53. package/lib/events/SceneFinishes.js.map +1 -1
  54. package/lib/instance.d.ts +30 -30
  55. package/lib/instance.js +30 -30
  56. package/lib/io/format.d.ts +15 -6
  57. package/lib/io/format.d.ts.map +1 -1
  58. package/lib/io/format.js +15 -6
  59. package/lib/io/format.js.map +1 -1
  60. package/lib/io/loader/ModuleLoader.d.ts +1 -1
  61. package/lib/io/loader/ModuleLoader.js +1 -1
  62. package/lib/io/reflection/ValueInspector.d.ts +1 -1
  63. package/lib/io/reflection/ValueInspector.js +2 -2
  64. package/lib/io/reflection/ValueInspector.js.map +1 -1
  65. package/lib/io/stringified.d.ts +1 -1
  66. package/lib/io/stringified.js +1 -1
  67. package/lib/io/trimmed.d.ts +1 -1
  68. package/lib/io/trimmed.js +1 -1
  69. package/lib/model/artifacts/HTTPRequestResponse.d.ts +2 -2
  70. package/lib/model/artifacts/HTTPRequestResponse.js +1 -1
  71. package/lib/screenplay/Activity.d.ts +10 -10
  72. package/lib/screenplay/Activity.js +5 -5
  73. package/lib/screenplay/Actor.d.ts +28 -28
  74. package/lib/screenplay/Actor.js +28 -28
  75. package/lib/screenplay/Answerable.d.ts +1 -1
  76. package/lib/screenplay/Answered.d.ts +2 -2
  77. package/lib/screenplay/Interaction.d.ts +17 -17
  78. package/lib/screenplay/Interaction.js +12 -12
  79. package/lib/screenplay/Optional.d.ts +1 -1
  80. package/lib/screenplay/Question.d.ts +48 -45
  81. package/lib/screenplay/Question.d.ts.map +1 -1
  82. package/lib/screenplay/Question.js +39 -36
  83. package/lib/screenplay/Question.js.map +1 -1
  84. package/lib/screenplay/RecursivelyAnswered.d.ts +2 -2
  85. package/lib/screenplay/Task.d.ts +19 -19
  86. package/lib/screenplay/Task.js +15 -15
  87. package/lib/screenplay/WithAnswerableProperties.d.ts +2 -2
  88. package/lib/screenplay/abilities/Ability.d.ts +48 -46
  89. package/lib/screenplay/abilities/Ability.d.ts.map +1 -1
  90. package/lib/screenplay/abilities/Ability.js +48 -46
  91. package/lib/screenplay/abilities/Ability.js.map +1 -1
  92. package/lib/screenplay/abilities/AbilityType.d.ts +5 -5
  93. package/lib/screenplay/abilities/AnswerQuestions.d.ts +3 -3
  94. package/lib/screenplay/abilities/AnswerQuestions.js +3 -3
  95. package/lib/screenplay/abilities/CanHaveAbilities.d.ts +4 -4
  96. package/lib/screenplay/abilities/Discardable.d.ts +8 -8
  97. package/lib/screenplay/abilities/Initialisable.d.ts +11 -11
  98. package/lib/screenplay/abilities/PerformActivities.d.ts +3 -3
  99. package/lib/screenplay/abilities/PerformActivities.js +3 -3
  100. package/lib/screenplay/abilities/UsesAbilities.d.ts +6 -6
  101. package/lib/screenplay/activities/PerformsActivities.d.ts +7 -7
  102. package/lib/screenplay/artifacts/CollectsArtifacts.d.ts +4 -5
  103. package/lib/screenplay/artifacts/CollectsArtifacts.d.ts.map +1 -1
  104. package/lib/screenplay/debugging/Debug.d.ts +7 -6
  105. package/lib/screenplay/debugging/Debug.d.ts.map +1 -1
  106. package/lib/screenplay/debugging/Debug.js +7 -6
  107. package/lib/screenplay/debugging/Debug.js.map +1 -1
  108. package/lib/screenplay/debugging/DebuggingResult.d.ts +1 -1
  109. package/lib/screenplay/debugging/Log.d.ts +7 -5
  110. package/lib/screenplay/debugging/Log.d.ts.map +1 -1
  111. package/lib/screenplay/debugging/Log.js +7 -5
  112. package/lib/screenplay/debugging/Log.js.map +1 -1
  113. package/lib/screenplay/notes/Notepad.d.ts +13 -13
  114. package/lib/screenplay/notes/Notepad.js +13 -13
  115. package/lib/screenplay/notes/NotepadAdapter.d.ts +16 -16
  116. package/lib/screenplay/notes/NotepadAdapter.js +16 -16
  117. package/lib/screenplay/notes/TakeNotes.d.ts +9 -9
  118. package/lib/screenplay/notes/TakeNotes.js +9 -9
  119. package/lib/screenplay/notes/notes.d.ts +6 -6
  120. package/lib/screenplay/notes/notes.js +6 -6
  121. package/lib/screenplay/questions/AnswersQuestions.d.ts +4 -4
  122. package/lib/screenplay/questions/ChainableMetaQuestion.d.ts +6 -6
  123. package/lib/screenplay/questions/Check.d.ts +2 -2
  124. package/lib/screenplay/questions/Check.js +2 -2
  125. package/lib/screenplay/questions/DescriptionFormattingOptions.d.ts +2 -2
  126. package/lib/screenplay/questions/Expectation.d.ts +17 -14
  127. package/lib/screenplay/questions/Expectation.d.ts.map +1 -1
  128. package/lib/screenplay/questions/Expectation.js +17 -14
  129. package/lib/screenplay/questions/Expectation.js.map +1 -1
  130. package/lib/screenplay/questions/List.d.ts +5 -5
  131. package/lib/screenplay/questions/List.js +5 -5
  132. package/lib/screenplay/questions/Masked.d.ts +4 -2
  133. package/lib/screenplay/questions/Masked.d.ts.map +1 -1
  134. package/lib/screenplay/questions/Masked.js +4 -2
  135. package/lib/screenplay/questions/Masked.js.map +1 -1
  136. package/lib/screenplay/questions/MetaQuestion.d.ts +9 -9
  137. package/lib/screenplay/questions/Unanswered.d.ts +2 -2
  138. package/lib/screenplay/questions/Unanswered.js +2 -2
  139. package/lib/screenplay/questions/expectations/ExpectationDetails.d.ts +1 -1
  140. package/lib/screenplay/questions/expectations/ExpectationDetails.js +1 -1
  141. package/lib/screenplay/questions/expectations/ExpectationMet.d.ts +1 -1
  142. package/lib/screenplay/questions/expectations/ExpectationMet.js +1 -1
  143. package/lib/screenplay/questions/expectations/ExpectationNotMet.d.ts +1 -1
  144. package/lib/screenplay/questions/expectations/ExpectationNotMet.js +1 -1
  145. package/lib/screenplay/questions/expectations/ExpectationOutcome.d.ts +2 -2
  146. package/lib/screenplay/questions/expectations/ExpectationOutcome.js +2 -2
  147. package/lib/screenplay/questions/tag-functions.d.ts +23 -21
  148. package/lib/screenplay/questions/tag-functions.d.ts.map +1 -1
  149. package/lib/screenplay/questions/tag-functions.js +5 -5
  150. package/lib/screenplay/questions/tag-functions.js.map +1 -1
  151. package/lib/screenplay/time/TellsTime.d.ts +4 -4
  152. package/lib/screenplay/time/abilities/ScheduleWork.d.ts +2 -2
  153. package/lib/screenplay/time/abilities/ScheduleWork.js +2 -2
  154. package/lib/screenplay/time/activities/Wait.d.ts +29 -27
  155. package/lib/screenplay/time/activities/Wait.d.ts.map +1 -1
  156. package/lib/screenplay/time/activities/Wait.js +29 -27
  157. package/lib/screenplay/time/activities/Wait.js.map +1 -1
  158. package/lib/screenplay/time/models/Clock.d.ts +4 -4
  159. package/lib/screenplay/time/models/Clock.js +4 -4
  160. package/lib/screenplay/time/models/Duration.d.ts +1 -1
  161. package/lib/screenplay/time/models/Duration.js +1 -1
  162. package/lib/screenplay/time/models/Timestamp.d.ts +2 -2
  163. package/lib/screenplay/time/models/Timestamp.js +2 -2
  164. package/lib/stage/Cast.d.ts +21 -21
  165. package/lib/stage/Cast.js +19 -19
  166. package/lib/stage/Extras.d.ts +1 -1
  167. package/lib/stage/Extras.js +1 -1
  168. package/lib/stage/ListensToDomainEvents.d.ts +7 -7
  169. package/lib/stage/Stage.d.ts +30 -30
  170. package/lib/stage/Stage.d.ts.map +1 -1
  171. package/lib/stage/Stage.js +30 -30
  172. package/lib/stage/Stage.js.map +1 -1
  173. package/lib/stage/StageCrewMember.d.ts +11 -11
  174. package/lib/stage/StageCrewMemberBuilder.d.ts +7 -7
  175. package/lib/stage/StageCrewMemberBuilderDependencies.d.ts +2 -2
  176. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts +4 -4
  177. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js +4 -4
  178. package/lib/stage/crew/stream-reporter/StreamReporter.d.ts +7 -7
  179. package/lib/stage/crew/stream-reporter/StreamReporter.js +7 -7
  180. package/package.json +4 -4
  181. package/src/Serenity.ts +22 -22
  182. package/src/adapter/OutputStream.ts +5 -4
  183. package/src/adapter/TestRunnerAdapter.ts +2 -2
  184. package/src/config/ClassDescription.ts +1 -1
  185. package/src/config/SerenityConfig.ts +22 -20
  186. package/src/errors/ErrorFactory.ts +2 -1
  187. package/src/errors/ErrorSerialiser.ts +3 -3
  188. package/src/errors/RaiseErrors.ts +9 -9
  189. package/src/errors/diff/AnsiDiffFormatter.ts +1 -1
  190. package/src/errors/diff/DiffFormatter.ts +1 -1
  191. package/src/errors/diff/NoOpDiffFormatter.ts +1 -1
  192. package/src/errors/model/AssertionError.ts +1 -1
  193. package/src/errors/model/ConfigurationError.ts +1 -1
  194. package/src/errors/model/ImplementationPendingError.ts +3 -3
  195. package/src/errors/model/ListItemNotFoundError.ts +2 -2
  196. package/src/errors/model/LogicError.ts +2 -2
  197. package/src/errors/model/OperationInterruptedError.ts +2 -2
  198. package/src/errors/model/RuntimeError.ts +2 -2
  199. package/src/errors/model/TestCompromisedError.ts +1 -1
  200. package/src/errors/model/TimeoutExpiredError.ts +2 -2
  201. package/src/errors/model/UnknownError.ts +1 -1
  202. package/src/events/ActivityFinished.ts +1 -1
  203. package/src/events/ActivityStarts.ts +1 -1
  204. package/src/events/BusinessRuleDetected.ts +1 -1
  205. package/src/events/SceneFinishes.ts +2 -1
  206. package/src/instance.ts +30 -30
  207. package/src/io/format.ts +15 -6
  208. package/src/io/loader/ModuleLoader.ts +1 -1
  209. package/src/io/reflection/ValueInspector.ts +3 -3
  210. package/src/io/stringified.ts +1 -1
  211. package/src/io/trimmed.ts +1 -1
  212. package/src/model/artifacts/HTTPRequestResponse.ts +2 -2
  213. package/src/screenplay/Activity.ts +10 -10
  214. package/src/screenplay/Actor.ts +28 -28
  215. package/src/screenplay/Answerable.ts +1 -1
  216. package/src/screenplay/Answered.ts +2 -2
  217. package/src/screenplay/Interaction.ts +17 -17
  218. package/src/screenplay/Optional.ts +1 -1
  219. package/src/screenplay/Question.ts +48 -45
  220. package/src/screenplay/RecursivelyAnswered.ts +2 -2
  221. package/src/screenplay/Task.ts +19 -19
  222. package/src/screenplay/WithAnswerableProperties.ts +2 -2
  223. package/src/screenplay/abilities/Ability.ts +48 -46
  224. package/src/screenplay/abilities/AbilityType.ts +5 -5
  225. package/src/screenplay/abilities/AnswerQuestions.ts +3 -3
  226. package/src/screenplay/abilities/CanHaveAbilities.ts +4 -4
  227. package/src/screenplay/abilities/Discardable.ts +8 -8
  228. package/src/screenplay/abilities/Initialisable.ts +11 -11
  229. package/src/screenplay/abilities/PerformActivities.ts +3 -3
  230. package/src/screenplay/abilities/UsesAbilities.ts +6 -6
  231. package/src/screenplay/activities/PerformsActivities.ts +7 -7
  232. package/src/screenplay/artifacts/CollectsArtifacts.ts +4 -5
  233. package/src/screenplay/debugging/Debug.ts +7 -6
  234. package/src/screenplay/debugging/DebuggingResult.ts +1 -1
  235. package/src/screenplay/debugging/Log.ts +7 -5
  236. package/src/screenplay/notes/Notepad.ts +13 -13
  237. package/src/screenplay/notes/NotepadAdapter.ts +16 -16
  238. package/src/screenplay/notes/TakeNotes.ts +9 -9
  239. package/src/screenplay/notes/notes.ts +6 -6
  240. package/src/screenplay/questions/AnswersQuestions.ts +4 -4
  241. package/src/screenplay/questions/ChainableMetaQuestion.ts +6 -6
  242. package/src/screenplay/questions/Check.ts +2 -2
  243. package/src/screenplay/questions/DescriptionFormattingOptions.ts +2 -2
  244. package/src/screenplay/questions/Expectation.ts +17 -14
  245. package/src/screenplay/questions/List.ts +5 -5
  246. package/src/screenplay/questions/Masked.ts +4 -2
  247. package/src/screenplay/questions/MetaQuestion.ts +9 -9
  248. package/src/screenplay/questions/Unanswered.ts +2 -2
  249. package/src/screenplay/questions/expectations/ExpectationDetails.ts +1 -1
  250. package/src/screenplay/questions/expectations/ExpectationMet.ts +1 -1
  251. package/src/screenplay/questions/expectations/ExpectationNotMet.ts +1 -1
  252. package/src/screenplay/questions/expectations/ExpectationOutcome.ts +2 -2
  253. package/src/screenplay/questions/tag-functions.ts +23 -21
  254. package/src/screenplay/time/TellsTime.ts +4 -4
  255. package/src/screenplay/time/abilities/ScheduleWork.ts +2 -2
  256. package/src/screenplay/time/activities/Wait.ts +29 -27
  257. package/src/screenplay/time/models/Clock.ts +4 -4
  258. package/src/screenplay/time/models/Duration.ts +1 -1
  259. package/src/screenplay/time/models/Timestamp.ts +2 -2
  260. package/src/stage/Cast.ts +21 -21
  261. package/src/stage/Extras.ts +1 -1
  262. package/src/stage/ListensToDomainEvents.ts +7 -7
  263. package/src/stage/Stage.ts +30 -30
  264. package/src/stage/StageCrewMember.ts +11 -11
  265. package/src/stage/StageCrewMemberBuilder.ts +7 -7
  266. package/src/stage/StageCrewMemberBuilderDependencies.ts +2 -2
  267. package/src/stage/crew/artifact-archiver/ArtifactArchiver.ts +4 -4
  268. package/src/stage/crew/stream-reporter/StreamReporter.ts +7 -7
@@ -1,21 +1,21 @@
1
1
  import { Ability } from '../abilities';
2
2
  import { Notepad } from './Notepad';
3
3
  /**
4
- * An {@apilink Ability} that enables an {@apilink Actor} to remember information
4
+ * An [`Ability`](https://serenity-js.org/api/core/class/Ability/) that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to remember information
5
5
  * to be recalled during a test scenario.
6
6
  *
7
- * Under the hood, {@apilink TakeNotes} uses a {@apilink Notepad}, which state
7
+ * Under the hood, [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) uses a [`Notepad`](https://serenity-js.org/api/core/class/Notepad/), which state
8
8
  * can be populated both during initialisation or while the test scenario is executed.
9
9
  * Populating the notepad when it's initialised can be useful to associate authentication credentials
10
10
  * or personal details with a given actor, while dynamic recording of notes during a test scenario
11
11
  * can be useful when the data to be recorded is not known upfront - for example when we want
12
12
  * the actor to remember a JWT stored in the browser and then use it when sending API requests.
13
13
  *
14
- * **Pro tip:** {@apilink TakeNotes}, {@apilink Notepad} and {@apilink notes} can be typed
14
+ * **Pro tip:** [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/), [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) and [`notes`](https://serenity-js.org/api/core/function/notes/) can be typed
15
15
  * using [TypeScript generics](https://www.typescriptlang.org/docs/handbook/2/generics.html)
16
16
  * to help you avoid typos when specifying note names.
17
17
  *
18
- * See [notes](/api/core/function/notes) and {@apilink Notepad} for more usage examples.
18
+ * See [notes](https://serenity-js.org/api/core/function/notes) and [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) for more usage examples.
19
19
  *
20
20
  * ## Remembering and retrieving a value
21
21
  *
@@ -223,20 +223,20 @@ import { Notepad } from './Notepad';
223
223
  *
224
224
  * ## Learn more
225
225
  *
226
- * - [notes](/api/core/function/notes)
227
- * - {@apilink Notepad}
226
+ * - [notes](https://serenity-js.org/api/core/function/notes)
227
+ * - [`Notepad`](https://serenity-js.org/api/core/class/Notepad/)
228
228
  *
229
229
  * @group Notes
230
230
  */
231
231
  export declare class TakeNotes<Notes_Type extends Record<any, any>> extends Ability {
232
232
  readonly notepad: Notepad<Notes_Type>;
233
233
  /**
234
- * Initialises an {@apilink Ability} to {@apilink TakeNotes} with {@apilink Notepad.empty}.
234
+ * Initialises an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) with [`Notepad.empty`](https://serenity-js.org/api/core/class/Notepad/#empty).
235
235
  */
236
236
  static usingAnEmptyNotepad<N extends Record<any, any>>(): TakeNotes<N>;
237
237
  /**
238
- * Initialises an {@apilink Ability} to {@apilink TakeNotes} using
239
- * a {@apilink Notepad.with} some initial state.
238
+ * Initialises an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) using
239
+ * a [`Notepad.with`](https://serenity-js.org/api/core/class/Notepad/#with) some initial state.
240
240
  *
241
241
  * @param notepad
242
242
  */
@@ -4,21 +4,21 @@ exports.TakeNotes = void 0;
4
4
  const abilities_1 = require("../abilities");
5
5
  const Notepad_1 = require("./Notepad");
6
6
  /**
7
- * An {@apilink Ability} that enables an {@apilink Actor} to remember information
7
+ * An [`Ability`](https://serenity-js.org/api/core/class/Ability/) that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to remember information
8
8
  * to be recalled during a test scenario.
9
9
  *
10
- * Under the hood, {@apilink TakeNotes} uses a {@apilink Notepad}, which state
10
+ * Under the hood, [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) uses a [`Notepad`](https://serenity-js.org/api/core/class/Notepad/), which state
11
11
  * can be populated both during initialisation or while the test scenario is executed.
12
12
  * Populating the notepad when it's initialised can be useful to associate authentication credentials
13
13
  * or personal details with a given actor, while dynamic recording of notes during a test scenario
14
14
  * can be useful when the data to be recorded is not known upfront - for example when we want
15
15
  * the actor to remember a JWT stored in the browser and then use it when sending API requests.
16
16
  *
17
- * **Pro tip:** {@apilink TakeNotes}, {@apilink Notepad} and {@apilink notes} can be typed
17
+ * **Pro tip:** [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/), [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) and [`notes`](https://serenity-js.org/api/core/function/notes/) can be typed
18
18
  * using [TypeScript generics](https://www.typescriptlang.org/docs/handbook/2/generics.html)
19
19
  * to help you avoid typos when specifying note names.
20
20
  *
21
- * See [notes](/api/core/function/notes) and {@apilink Notepad} for more usage examples.
21
+ * See [notes](https://serenity-js.org/api/core/function/notes) and [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) for more usage examples.
22
22
  *
23
23
  * ## Remembering and retrieving a value
24
24
  *
@@ -226,22 +226,22 @@ const Notepad_1 = require("./Notepad");
226
226
  *
227
227
  * ## Learn more
228
228
  *
229
- * - [notes](/api/core/function/notes)
230
- * - {@apilink Notepad}
229
+ * - [notes](https://serenity-js.org/api/core/function/notes)
230
+ * - [`Notepad`](https://serenity-js.org/api/core/class/Notepad/)
231
231
  *
232
232
  * @group Notes
233
233
  */
234
234
  class TakeNotes extends abilities_1.Ability {
235
235
  notepad;
236
236
  /**
237
- * Initialises an {@apilink Ability} to {@apilink TakeNotes} with {@apilink Notepad.empty}.
237
+ * Initialises an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) with [`Notepad.empty`](https://serenity-js.org/api/core/class/Notepad/#empty).
238
238
  */
239
239
  static usingAnEmptyNotepad() {
240
240
  return TakeNotes.using(Notepad_1.Notepad.empty());
241
241
  }
242
242
  /**
243
- * Initialises an {@apilink Ability} to {@apilink TakeNotes} using
244
- * a {@apilink Notepad.with} some initial state.
243
+ * Initialises an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) using
244
+ * a [`Notepad.with`](https://serenity-js.org/api/core/class/Notepad/#with) some initial state.
245
245
  *
246
246
  * @param notepad
247
247
  */
@@ -1,9 +1,9 @@
1
1
  import type { NotepadAdapter } from './NotepadAdapter';
2
2
  /**
3
- * Alias for {@apilink Notepad.notes}.
3
+ * Alias for [`Notepad.notes`](https://serenity-js.org/api/core/class/Notepad/#notes).
4
4
  *
5
- * **Pro tip:** `notes<T>().get(subject)` returns a {@apilink NotepadAdapter} to make accessing the APIs
6
- * of the underlying type easier. Check {@apilink NotepadAdapter} for more examples.
5
+ * **Pro tip:** `notes<T>().get(subject)` returns a [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/) to make accessing the APIs
6
+ * of the underlying type easier. Check [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/) for more examples.
7
7
  *
8
8
  * ## Working with untyped notes
9
9
  *
@@ -107,9 +107,9 @@ import type { NotepadAdapter } from './NotepadAdapter';
107
107
  *
108
108
  * ## Learn more
109
109
  *
110
- * - {@apilink NotepadAdapter}
111
- * - {@apilink Notepad.notes}
112
- * - {@apilink QuestionAdapter}
110
+ * - [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/)
111
+ * - [`Notepad.notes`](https://serenity-js.org/api/core/class/Notepad/#notes)
112
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
113
113
  *
114
114
  * @group Notes
115
115
  */
@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.notes = void 0;
4
4
  const Notepad_1 = require("./Notepad");
5
5
  /**
6
- * Alias for {@apilink Notepad.notes}.
6
+ * Alias for [`Notepad.notes`](https://serenity-js.org/api/core/class/Notepad/#notes).
7
7
  *
8
- * **Pro tip:** `notes<T>().get(subject)` returns a {@apilink NotepadAdapter} to make accessing the APIs
9
- * of the underlying type easier. Check {@apilink NotepadAdapter} for more examples.
8
+ * **Pro tip:** `notes<T>().get(subject)` returns a [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/) to make accessing the APIs
9
+ * of the underlying type easier. Check [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/) for more examples.
10
10
  *
11
11
  * ## Working with untyped notes
12
12
  *
@@ -110,9 +110,9 @@ const Notepad_1 = require("./Notepad");
110
110
  *
111
111
  * ## Learn more
112
112
  *
113
- * - {@apilink NotepadAdapter}
114
- * - {@apilink Notepad.notes}
115
- * - {@apilink QuestionAdapter}
113
+ * - [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/)
114
+ * - [`Notepad.notes`](https://serenity-js.org/api/core/class/Notepad/#notes)
115
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
116
116
  *
117
117
  * @group Notes
118
118
  */
@@ -1,17 +1,17 @@
1
1
  import type { Answerable } from '../Answerable';
2
2
  /**
3
- * Describes an {@apilink Actor} who can answer a {@apilink Question} about the system under test.
3
+ * Describes an [`Actor`](https://serenity-js.org/api/core/class/Actor/) who can answer a [`Question`](https://serenity-js.org/api/core/class/Question/) about the system under test.
4
4
  *
5
5
  * ## Learn more
6
6
  *
7
- * - {@apilink Question}
8
- * - {@apilink Actor}
7
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
8
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
9
9
  *
10
10
  * @group Actors
11
11
  */
12
12
  export interface AnswersQuestions {
13
13
  /**
14
- * Makes the {@apilink Actor} evaluate an {@apilink Answerable}
14
+ * Makes the [`Actor`](https://serenity-js.org/api/core/class/Actor/) evaluate an [`Answerable`](https://serenity-js.org/api/core/#Answerable)
15
15
  * and return the value it holds.
16
16
  */
17
17
  answer<T>(answerable: Answerable<T>): Promise<T>;
@@ -2,24 +2,24 @@ import type { Answerable } from '../Answerable';
2
2
  import type { Question } from '../Question';
3
3
  import type { MetaQuestion } from './MetaQuestion';
4
4
  /**
5
- * A chainable meta-question is a {@apilink MetaQuestion} that can be answered
6
- * in the context of another {@apilink Answerable},
5
+ * A chainable meta-question is a [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/) that can be answered
6
+ * in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable),
7
7
  * and form a chain of transformations.
8
8
  *
9
- * {@apilink MetaQuestion|Meta questions} are typically used when filtering a {@apilink List}.
9
+ * [Meta-questions](https://serenity-js.org/api/core/interface/MetaQuestion/) are typically used when filtering a [`List`](https://serenity-js.org/api/core/class/List/).
10
10
  *
11
11
  * ## Learn more
12
- * - {@apilink List}
12
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
13
13
  *
14
14
  * @group Questions
15
15
  */
16
16
  export interface ChainableMetaQuestion<Supported_Context_Type, Returned_Question_Type extends Question<unknown>> extends MetaQuestion<Supported_Context_Type, Returned_Question_Type & ChainableMetaQuestion<Supported_Context_Type, Returned_Question_Type>> {
17
17
  /**
18
- * Answers the given `ChainableMetaQuestion` in the context of another {@apilink Answerable}
18
+ * Answers the given `ChainableMetaQuestion` in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable)
19
19
  * and returns another `ChainableMetaQuestion` ready for further chaining.
20
20
  *
21
21
  * #### Learn more
22
- * - {@apilink List}
22
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
23
23
  */
24
24
  of(context: Answerable<Supported_Context_Type>): Returned_Question_Type & ChainableMetaQuestion<Supported_Context_Type, Returned_Question_Type>;
25
25
  }
@@ -6,7 +6,7 @@ import { Task } from '../Task';
6
6
  import type { Expectation } from './Expectation';
7
7
  /**
8
8
  * A [flow control statement](https://en.wikipedia.org/wiki/Control_flow)
9
- * that enables an {@apilink Actor} to decide between two alternate series of {@apilink Activity|activities}.
9
+ * that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to decide between two alternate series of [activities](https://serenity-js.org/api/core/class/Activity/).
10
10
  *
11
11
  * Think of it as a Screenplay Pattern equivalent of the traditional `if` statement.
12
12
  *
@@ -54,7 +54,7 @@ export declare class Check<Actual> extends Task {
54
54
  protected constructor(actual: Answerable<Actual>, expectation: Expectation<Actual>, activities: Activity[], alternativeActivities?: Activity[]);
55
55
  /**
56
56
  * @param alternativeActivities
57
- * A sequence of {@apilink Activity|activities} to perform when the {@apilink Expectation} is not met.
57
+ * A sequence of [activities](https://serenity-js.org/api/core/class/Activity/) to perform when the [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) is not met.
58
58
  */
59
59
  otherwise(...alternativeActivities: Activity[]): Task;
60
60
  /**
@@ -6,7 +6,7 @@ const Task_1 = require("../Task");
6
6
  const expectations_1 = require("./expectations");
7
7
  /**
8
8
  * A [flow control statement](https://en.wikipedia.org/wiki/Control_flow)
9
- * that enables an {@apilink Actor} to decide between two alternate series of {@apilink Activity|activities}.
9
+ * that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to decide between two alternate series of [activities](https://serenity-js.org/api/core/class/Activity/).
10
10
  *
11
11
  * Think of it as a Screenplay Pattern equivalent of the traditional `if` statement.
12
12
  *
@@ -63,7 +63,7 @@ class Check extends Task_1.Task {
63
63
  }
64
64
  /**
65
65
  * @param alternativeActivities
66
- * A sequence of {@apilink Activity|activities} to perform when the {@apilink Expectation} is not met.
66
+ * A sequence of [activities](https://serenity-js.org/api/core/class/Activity/) to perform when the [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) is not met.
67
67
  */
68
68
  otherwise(...alternativeActivities) {
69
69
  return new Check(this.actual, this.expectation, this.activities, alternativeActivities);
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Configuration options for {@apilink Question.formattedValue} and
3
- * the [`the`](/api/core/function/the/) function.
2
+ * Configuration options for [`Question.formattedValue`](https://serenity-js.org/api/core/class/Question/#formattedValue) and
3
+ * the [`the`](https://serenity-js.org/api/core/function/the/) function.
4
4
  *
5
5
  * @group Questions
6
6
  */
@@ -9,8 +9,11 @@ type AnswerableArguments<Arguments extends Array<unknown>> = {
9
9
  [Index in keyof Arguments]: Answerable<Arguments[Index]>;
10
10
  };
11
11
  /**
12
- * Defines an expectation to be used with {@apilink @apilink Wait.until}, {@apilink Check.whether}, {@apilink Ensure.that}
13
- * and as part of the Page Element Query Language with {@apilink PageElements.where} and {@apilink List.where}.
12
+ * Defines an expectation to be used with [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until),
13
+ * [`Check.whether`](https://serenity-js.org/api/core/class/Check/#whether),
14
+ * [`Ensure.that`](https://serenity-js.org/api/assertions/class/Ensure/#that)
15
+ * and as part of the Page Element Query Language with [`PageElements.where`](https://serenity-js.org/api/web/class/PageElements/#where)
16
+ * and [`List.where`](https://serenity-js.org/api/core/class/List/#where).
14
17
  *
15
18
  * @group Expectations
16
19
  */
@@ -18,7 +21,7 @@ export declare class Expectation<Actual> extends Describable {
18
21
  private readonly functionName;
19
22
  private readonly predicate;
20
23
  /**
21
- * A factory method to that makes defining custom {@apilink Expectation|expectations} easier
24
+ * A factory method to that makes defining custom [expectations](https://serenity-js.org/api/core/class/Expectation/) easier
22
25
  *
23
26
  * #### Defining a custom expectation
24
27
  *
@@ -89,22 +92,22 @@ export declare class Expectation<Actual> extends Describable {
89
92
  * ```
90
93
  *
91
94
  * #### Learn more
92
- * - {@apilink Ensure}
93
- * - {@apilink Check}
94
- * - {@apilink Wait}
95
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
96
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
97
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
95
98
  *
96
99
  * @param functionName
97
- * Name of the expectation function to be used when producing an {@apilink AssertionError}
100
+ * Name of the expectation function to be used when producing an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/)
98
101
  *
99
102
  * @param relationship
100
103
  * Human-readable description of the relationship between the `expected` and the `actual` values.
101
- * Used when reporting {@apilink Activity|activities} performed by an {@apilink Actor|actor}
104
+ * Used when reporting [activities](https://serenity-js.org/api/core/class/Activity/) performed by an [actor](https://serenity-js.org/api/core/class/Actor/)
102
105
  *
103
106
  * @param predicate
104
107
  */
105
108
  static define<Actual_Type, PredicateArguments extends Array<unknown>>(functionName: string, relationship: ((...answerableArguments: AnswerableArguments<PredicateArguments>) => Answerable<string>) | Answerable<string>, predicate: (actual: Actual_Type, ...predicateArguments: PredicateArguments) => Promise<boolean> | boolean): (...answerableArguments: AnswerableArguments<PredicateArguments>) => Expectation<Actual_Type>;
106
109
  /**
107
- * Used to define a simple {@apilink Expectation}
110
+ * Used to define a simple [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
108
111
  *
109
112
  * #### Simple parameterised expectation
110
113
  *
@@ -133,9 +136,9 @@ export declare class Expectation<Actual> extends Describable {
133
136
  soThat: (simplifiedPredicate: (actualValue: Actual_Type, expectedValue: Expected_Type) => Promise<boolean> | boolean) => Expectation<Actual_Type>;
134
137
  };
135
138
  /**
136
- * Used to compose {@apilink Expectation|expectations}.
139
+ * Used to compose [expectations](https://serenity-js.org/api/core/class/Expectation/).
137
140
  *
138
- * #### Composing {@apilink Expectation|expectations}
141
+ * #### Composing [expectations](https://serenity-js.org/api/core/class/Expectation/)
139
142
  *
140
143
  * ```ts
141
144
  * import { actorCalled, Expectation } from '@serenity-js/core'
@@ -167,9 +170,9 @@ export declare class Expectation<Actual> extends Describable {
167
170
  };
168
171
  protected constructor(functionName: string, description: Answerable<string>, predicate: Predicate<Actual>);
169
172
  /**
170
- * Returns a {@apilink QuestionAdapter} that resolves to {@apilink ExpectationOutcome}
171
- * indicating that the {@apilink ExpectationMet|expectation was met}
172
- * or that the {@apilink ExpectationNotMet|expectation was not met}
173
+ * Returns a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/)
174
+ * indicating that the [expectation was met](https://serenity-js.org/api/core/class/ExpectationMet/)
175
+ * or that the [expectation was not met](https://serenity-js.org/api/core/class/ExpectationNotMet/)
173
176
  *
174
177
  * @param actual
175
178
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Expectation.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/Expectation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,eAAe,EAAC,MAAM,UAAU,CAAC;AAG7E,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,KAChF,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AAErD,KAAK,mBAAmB,CAAC,SAAS,SAAS,KAAK,CAAC,OAAO,CAAC,IAAI;KAAG,KAAK,IAAI,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;CAAE,CAAC;AAE1H;;;;;GAKG;AACH,qBAAa,WAAW,CAAC,MAAM,CAAE,SAAQ,WAAW;IAiO5C,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAjO9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoFG;IACH,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,kBAAkB,SAAS,KAAK,CAAC,OAAO,CAAC,EAChE,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,CAAC,CAAC,GAAG,mBAAmB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,EAC5H,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,kBAAkB,EAAE,kBAAkB,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAC1G,CAAC,GAAG,mBAAmB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,WAAW,CAAC,WAAW,CAAC;IAmChG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,GAAG;QACtH,MAAM,EAAE,CAAC,mBAAmB,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,KAAK,WAAW,CAAC,WAAW,CAAC,CAAC;KACrJ;IAwBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,MAAM,GAAG;QAC9C,YAAY,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC,WAAW,CAAC,CAAC;KACrF;IAcD,SAAS,aACY,YAAY,EAAE,MAAM,EACrC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,EACd,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;IAKjD;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,kBAAkB,CAAC;IAIzE;;OAEG;IACH,WAAW,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,IAAI;CAKrD"}
1
+ {"version":3,"file":"Expectation.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/Expectation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,eAAe,EAAC,MAAM,UAAU,CAAC;AAG7E,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,KAChF,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AAErD,KAAK,mBAAmB,CAAC,SAAS,SAAS,KAAK,CAAC,OAAO,CAAC,IAAI;KAAG,KAAK,IAAI,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;CAAE,CAAC;AAE1H;;;;;;;;GAQG;AACH,qBAAa,WAAW,CAAC,MAAM,CAAE,SAAQ,WAAW;IAiO5C,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAjO9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoFG;IACH,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,kBAAkB,SAAS,KAAK,CAAC,OAAO,CAAC,EAChE,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,CAAC,CAAC,GAAG,mBAAmB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,EAC5H,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,kBAAkB,EAAE,kBAAkB,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAC1G,CAAC,GAAG,mBAAmB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,WAAW,CAAC,WAAW,CAAC;IAmChG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,GAAG;QACtH,MAAM,EAAE,CAAC,mBAAmB,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,KAAK,WAAW,CAAC,WAAW,CAAC,CAAC;KACrJ;IAwBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,MAAM,GAAG;QAC9C,YAAY,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC,WAAW,CAAC,CAAC;KACrF;IAcD,SAAS,aACY,YAAY,EAAE,MAAM,EACrC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,EACd,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;IAKjD;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,kBAAkB,CAAC;IAIzE;;OAEG;IACH,WAAW,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,IAAI;CAKrD"}
@@ -7,8 +7,11 @@ const index_1 = require("../index");
7
7
  const Question_1 = require("../Question");
8
8
  const questions_1 = require("../questions");
9
9
  /**
10
- * Defines an expectation to be used with {@apilink @apilink Wait.until}, {@apilink Check.whether}, {@apilink Ensure.that}
11
- * and as part of the Page Element Query Language with {@apilink PageElements.where} and {@apilink List.where}.
10
+ * Defines an expectation to be used with [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until),
11
+ * [`Check.whether`](https://serenity-js.org/api/core/class/Check/#whether),
12
+ * [`Ensure.that`](https://serenity-js.org/api/assertions/class/Ensure/#that)
13
+ * and as part of the Page Element Query Language with [`PageElements.where`](https://serenity-js.org/api/web/class/PageElements/#where)
14
+ * and [`List.where`](https://serenity-js.org/api/core/class/List/#where).
12
15
  *
13
16
  * @group Expectations
14
17
  */
@@ -16,7 +19,7 @@ class Expectation extends questions_1.Describable {
16
19
  functionName;
17
20
  predicate;
18
21
  /**
19
- * A factory method to that makes defining custom {@apilink Expectation|expectations} easier
22
+ * A factory method to that makes defining custom [expectations](https://serenity-js.org/api/core/class/Expectation/) easier
20
23
  *
21
24
  * #### Defining a custom expectation
22
25
  *
@@ -87,16 +90,16 @@ class Expectation extends questions_1.Describable {
87
90
  * ```
88
91
  *
89
92
  * #### Learn more
90
- * - {@apilink Ensure}
91
- * - {@apilink Check}
92
- * - {@apilink Wait}
93
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
94
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
95
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
93
96
  *
94
97
  * @param functionName
95
- * Name of the expectation function to be used when producing an {@apilink AssertionError}
98
+ * Name of the expectation function to be used when producing an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/)
96
99
  *
97
100
  * @param relationship
98
101
  * Human-readable description of the relationship between the `expected` and the `actual` values.
99
- * Used when reporting {@apilink Activity|activities} performed by an {@apilink Actor|actor}
102
+ * Used when reporting [activities](https://serenity-js.org/api/core/class/Activity/) performed by an [actor](https://serenity-js.org/api/core/class/Actor/)
100
103
  *
101
104
  * @param predicate
102
105
  */
@@ -121,7 +124,7 @@ class Expectation extends questions_1.Describable {
121
124
  }, 'name', { value: functionName, writable: false });
122
125
  }
123
126
  /**
124
- * Used to define a simple {@apilink Expectation}
127
+ * Used to define a simple [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
125
128
  *
126
129
  * #### Simple parameterised expectation
127
130
  *
@@ -163,9 +166,9 @@ class Expectation extends questions_1.Describable {
163
166
  });
164
167
  }
165
168
  /**
166
- * Used to compose {@apilink Expectation|expectations}.
169
+ * Used to compose [expectations](https://serenity-js.org/api/core/class/Expectation/).
167
170
  *
168
- * #### Composing {@apilink Expectation|expectations}
171
+ * #### Composing [expectations](https://serenity-js.org/api/core/class/Expectation/)
169
172
  *
170
173
  * ```ts
171
174
  * import { actorCalled, Expectation } from '@serenity-js/core'
@@ -207,9 +210,9 @@ class Expectation extends questions_1.Describable {
207
210
  this.predicate = predicate;
208
211
  }
209
212
  /**
210
- * Returns a {@apilink QuestionAdapter} that resolves to {@apilink ExpectationOutcome}
211
- * indicating that the {@apilink ExpectationMet|expectation was met}
212
- * or that the {@apilink ExpectationNotMet|expectation was not met}
213
+ * Returns a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/)
214
+ * indicating that the [expectation was met](https://serenity-js.org/api/core/class/ExpectationMet/)
215
+ * or that the [expectation was not met](https://serenity-js.org/api/core/class/ExpectationNotMet/)
213
216
  *
214
217
  * @param actual
215
218
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Expectation.js","sourceRoot":"","sources":["../../../src/screenplay/questions/Expectation.ts"],"names":[],"mappings":";;;AAEA,iCAAuC;AACvC,2BAA4E;AAE5E,oCAA+B;AAC/B,0CAAuC;AACvC,4CAA2C;AAW3C;;;;;GAKG;AACH,MAAa,WAAoB,SAAQ,uBAAW;IAiO3B;IAEA;IAjOrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoFG;IACH,MAAM,CAAC,MAAM,CACT,YAAoB,EACpB,YAA4H,EAC5H,SAAyG;QAGzG,OAAO,MAAM,CAAC,cAAc,CAAC,UAAS,GAAG,mBAA4D;YACjG,MAAM,WAAW,GAAuB,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,mBAAmB,CAAC;gBAC7G,CAAC,CAAC,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,WAAG,EAAA,GAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,YAAY,EAAG,IAAK,mBAAmB,CAAC,CAAC,CAAE,EAAE;oBACxG,CAAC,CAAC,YAAY,CAAC,CAAC;YAExB,OAAO,IAAI,WAAW,CAClB,YAAY,EACZ,WAAW,EACX,KAAK,EAAE,KAAuB,EAAE,WAAoC,EAA+B,EAAE;gBACjG,MAAM,kBAAkB,GAAG,MAAM,IAAA,aAAQ,EAAC,mBAAmB,EAAE,kBAAkB,CAAC,EAAE,CAChF,KAAK,CAAC,MAAM,CAAC,kBAA2C,CAAC,CAC5D,CAAC;gBAEF,MAAM,MAAM,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAElD,MAAM,MAAM,GAAM,MAAM,SAAS,CAAC,MAAM,EAAE,GAAG,kBAAwC,CAAC,CAAC;gBAEvF,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAExD,MAAM,kBAAkB,GAAG,sBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,kBAAkB,CAAC,CAAC;gBAEtF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,GAAG,CAAC;oBAC1C,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;oBACvB,CAAC,CAAC,IAAI,CAAC,CAAK,2FAA2F;gBAE3G,OAAO,MAAM;oBACT,CAAC,CAAC,IAAI,kBAAc,CAAC,eAAe,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC;oBAC3E,CAAC,CAAC,IAAI,qBAAiB,CAAC,eAAe,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YACvF,CAAC,CACJ,CAAA;QACL,CAAC,EAAE,MAAM,EAAE,EAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,gBAAgB,CAA6B,gBAAwB,EAAE,aAAyC;QAGnH,OAAO,CAAC;YACJ,MAAM,EAAE,CAAC,mBAA2G,EAA4B,EAAE;gBAC9I,MAAM,OAAO,GAAG,gBAAgB,GAAG,GAAG,GAAG,IAAA,MAAC,EAAA,GAAG,aAAa,EAAE,CAAC;gBAE7D,OAAO,IAAI,WAAW,CAClB,SAAS,EACT,OAAO,EACP,KAAK,EAAE,KAAuB,EAAE,WAAoC,EAA+B,EAAE;oBACjG,MAAM,QAAQ,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;oBACpD,MAAM,MAAM,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;oBAElD,MAAM,MAAM,GAAM,MAAM,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAC9D,MAAM,kBAAkB,GAAG,sBAAkB,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBAE5D,OAAO,MAAM;wBACT,CAAC,CAAC,IAAI,kBAAc,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC;wBACnE,CAAC,CAAC,IAAI,qBAAiB,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC/E,CAAC,CACJ,CAAC;YACN,CAAC;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EAAE,CAAc,gBAAwB;QAG3C,OAAO;YACH,YAAY,EAAE,CAAC,WAAqC,EAA4B,EAAE;gBAC9E,OAAO,IAAI,WAAW,CAClB,SAAS,EACT,gBAAgB,EAChB,KAAK,EAAE,KAAuB,EAAE,WAAoC,EAA+B,EAAE;oBACjG,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;gBACjE,CAAC,CACJ,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,YACqB,YAAoB,EACrC,WAA+B,EACd,SAA4B;QAE7C,KAAK,CAAC,WAAW,CAAC,CAAC;QAJF,iBAAY,GAAZ,YAAY,CAAQ;QAEpB,cAAS,GAAT,SAAS,CAAmB;IAGjD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,MAA0B;QAC/B,OAAO,mBAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,WAA+B;QACvC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAElC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA3PD,kCA2PC"}
1
+ {"version":3,"file":"Expectation.js","sourceRoot":"","sources":["../../../src/screenplay/questions/Expectation.ts"],"names":[],"mappings":";;;AAEA,iCAAuC;AACvC,2BAA4E;AAE5E,oCAA+B;AAC/B,0CAAuC;AACvC,4CAA2C;AAW3C;;;;;;;;GAQG;AACH,MAAa,WAAoB,SAAQ,uBAAW;IAiO3B;IAEA;IAjOrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoFG;IACH,MAAM,CAAC,MAAM,CACT,YAAoB,EACpB,YAA4H,EAC5H,SAAyG;QAGzG,OAAO,MAAM,CAAC,cAAc,CAAC,UAAS,GAAG,mBAA4D;YACjG,MAAM,WAAW,GAAuB,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,mBAAmB,CAAC;gBAC7G,CAAC,CAAC,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,WAAG,EAAA,GAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,YAAY,EAAG,IAAK,mBAAmB,CAAC,CAAC,CAAE,EAAE;oBACxG,CAAC,CAAC,YAAY,CAAC,CAAC;YAExB,OAAO,IAAI,WAAW,CAClB,YAAY,EACZ,WAAW,EACX,KAAK,EAAE,KAAuB,EAAE,WAAoC,EAA+B,EAAE;gBACjG,MAAM,kBAAkB,GAAG,MAAM,IAAA,aAAQ,EAAC,mBAAmB,EAAE,kBAAkB,CAAC,EAAE,CAChF,KAAK,CAAC,MAAM,CAAC,kBAA2C,CAAC,CAC5D,CAAC;gBAEF,MAAM,MAAM,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAElD,MAAM,MAAM,GAAM,MAAM,SAAS,CAAC,MAAM,EAAE,GAAG,kBAAwC,CAAC,CAAC;gBAEvF,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAExD,MAAM,kBAAkB,GAAG,sBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,kBAAkB,CAAC,CAAC;gBAEtF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,GAAG,CAAC;oBAC1C,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;oBACvB,CAAC,CAAC,IAAI,CAAC,CAAK,2FAA2F;gBAE3G,OAAO,MAAM;oBACT,CAAC,CAAC,IAAI,kBAAc,CAAC,eAAe,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC;oBAC3E,CAAC,CAAC,IAAI,qBAAiB,CAAC,eAAe,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YACvF,CAAC,CACJ,CAAA;QACL,CAAC,EAAE,MAAM,EAAE,EAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,gBAAgB,CAA6B,gBAAwB,EAAE,aAAyC;QAGnH,OAAO,CAAC;YACJ,MAAM,EAAE,CAAC,mBAA2G,EAA4B,EAAE;gBAC9I,MAAM,OAAO,GAAG,gBAAgB,GAAG,GAAG,GAAG,IAAA,MAAC,EAAA,GAAG,aAAa,EAAE,CAAC;gBAE7D,OAAO,IAAI,WAAW,CAClB,SAAS,EACT,OAAO,EACP,KAAK,EAAE,KAAuB,EAAE,WAAoC,EAA+B,EAAE;oBACjG,MAAM,QAAQ,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;oBACpD,MAAM,MAAM,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;oBAElD,MAAM,MAAM,GAAM,MAAM,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAC9D,MAAM,kBAAkB,GAAG,sBAAkB,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBAE5D,OAAO,MAAM;wBACT,CAAC,CAAC,IAAI,kBAAc,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC;wBACnE,CAAC,CAAC,IAAI,qBAAiB,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC/E,CAAC,CACJ,CAAC;YACN,CAAC;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EAAE,CAAc,gBAAwB;QAG3C,OAAO;YACH,YAAY,EAAE,CAAC,WAAqC,EAA4B,EAAE;gBAC9E,OAAO,IAAI,WAAW,CAClB,SAAS,EACT,gBAAgB,EAChB,KAAK,EAAE,KAAuB,EAAE,WAAoC,EAA+B,EAAE;oBACjG,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;gBACjE,CAAC,CACJ,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,YACqB,YAAoB,EACrC,WAA+B,EACd,SAA4B;QAE7C,KAAK,CAAC,WAAW,CAAC,CAAC;QAJF,iBAAY,GAAZ,YAAY,CAAQ;QAEpB,cAAS,GAAT,SAAS,CAAmB;IAGjD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,MAA0B;QAC/B,OAAO,mBAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,WAA+B;QACvC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAElC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA3PD,kCA2PC"}
@@ -7,8 +7,8 @@ import type { AnswersQuestions, ChainableMetaQuestion, MetaQuestion } from '../q
7
7
  import { Task } from '../Task';
8
8
  import type { Expectation } from './Expectation';
9
9
  /**
10
- * Serenity/JS Screenplay Pattern-style wrapper around {@apilink Array}
11
- * and array-like structures - see {@apilink PageElements}.
10
+ * Serenity/JS Screenplay Pattern-style wrapper around [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
11
+ * and array-like structures - see [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
12
12
  *
13
13
  * @group Questions
14
14
  */
@@ -33,10 +33,10 @@ export declare abstract class List<Item_Type> extends Question<Promise<Array<Ite
33
33
  }
34
34
  /**
35
35
  * Serenity/JS Screenplay Pattern-style wrapper around
36
- * a {@apilink ChainableMetaQuestion} representing a collection
37
- * that can be resolved in `Supported_Context_Type` of another {@apilink Question}.
36
+ * a [`ChainableMetaQuestion`](https://serenity-js.org/api/core/interface/ChainableMetaQuestion/) representing a collection
37
+ * that can be resolved in `Supported_Context_Type` of another [`Question`](https://serenity-js.org/api/core/class/Question/).
38
38
  *
39
- * For example, {@apilink PageElements.located} returns `MetaList<PageElement>`,
39
+ * For example, [`PageElements.located`](https://serenity-js.org/api/web/class/PageElements/#located) returns `MetaList<PageElement>`,
40
40
  * which allows for the collection of page elements to be resolved in the context
41
41
  * of dynamically-provided root element.
42
42
  *
@@ -7,8 +7,8 @@ const Question_1 = require("../Question");
7
7
  const Task_1 = require("../Task");
8
8
  const expectations_1 = require("./expectations");
9
9
  /**
10
- * Serenity/JS Screenplay Pattern-style wrapper around {@apilink Array}
11
- * and array-like structures - see {@apilink PageElements}.
10
+ * Serenity/JS Screenplay Pattern-style wrapper around [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
11
+ * and array-like structures - see [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
12
12
  *
13
13
  * @group Questions
14
14
  */
@@ -99,10 +99,10 @@ class ArrayList extends List {
99
99
  }
100
100
  /**
101
101
  * Serenity/JS Screenplay Pattern-style wrapper around
102
- * a {@apilink ChainableMetaQuestion} representing a collection
103
- * that can be resolved in `Supported_Context_Type` of another {@apilink Question}.
102
+ * a [`ChainableMetaQuestion`](https://serenity-js.org/api/core/interface/ChainableMetaQuestion/) representing a collection
103
+ * that can be resolved in `Supported_Context_Type` of another [`Question`](https://serenity-js.org/api/core/class/Question/).
104
104
  *
105
- * For example, {@apilink PageElements.located} returns `MetaList<PageElement>`,
105
+ * For example, [`PageElements.located`](https://serenity-js.org/api/web/class/PageElements/#located) returns `MetaList<PageElement>`,
106
106
  * which allows for the collection of page elements to be resolved in the context
107
107
  * of dynamically-provided root element.
108
108
  *
@@ -27,8 +27,10 @@ export declare class Masked {
27
27
  * );
28
28
  * ```
29
29
  *
30
- * @param parameter - An {@link Answerable} representing the masked value.
31
- * @returns A {@link QuestionAdapter} representing the masked value.
30
+ * @param parameter
31
+ * An [`Answerable`](https://serenity-js.org/api/core/#Answerable) representing the masked value.
32
+ * @returns
33
+ * A [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the masked value.
32
34
  */
33
35
  static valueOf(parameter: Answerable<string>): QuestionAdapter<string>;
34
36
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Masked.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/Masked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAY,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,qBAAa,MAAM;IAEf;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC;CAGzE"}
1
+ {"version":3,"file":"Masked.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/Masked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAY,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,qBAAa,MAAM;IAEf;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC;CAGzE"}
@@ -29,8 +29,10 @@ class Masked {
29
29
  * );
30
30
  * ```
31
31
  *
32
- * @param parameter - An {@link Answerable} representing the masked value.
33
- * @returns A {@link QuestionAdapter} representing the masked value.
32
+ * @param parameter
33
+ * An [`Answerable`](https://serenity-js.org/api/core/#Answerable) representing the masked value.
34
+ * @returns
35
+ * A [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the masked value.
34
36
  */
35
37
  static valueOf(parameter) {
36
38
  return Question_1.Question.about('[a masked value]', async (actor) => actor.answer(parameter));
@@ -1 +1 @@
1
- {"version":3,"file":"Masked.js","sourceRoot":"","sources":["../../../src/screenplay/questions/Masked.ts"],"names":[],"mappings":";;;AACA,0CAA6D;AAE7D;;;;;;;;;;GAUG;AACH,MAAa,MAAM;IAEf;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,OAAO,CAAC,SAA6B;QACxC,OAAO,mBAAQ,CAAC,KAAK,CAAC,kBAAkB,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IACtF,CAAC;CACJ;AAvBD,wBAuBC"}
1
+ {"version":3,"file":"Masked.js","sourceRoot":"","sources":["../../../src/screenplay/questions/Masked.ts"],"names":[],"mappings":";;;AACA,0CAA6D;AAE7D;;;;;;;;;;GAUG;AACH,MAAa,MAAM;IAEf;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,OAAO,CAAC,SAA6B;QACxC,OAAO,mBAAQ,CAAC,KAAK,CAAC,kBAAkB,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IACtF,CAAC;CACJ;AAzBD,wBAyBC"}
@@ -1,30 +1,30 @@
1
1
  import type { Answerable } from '../Answerable';
2
2
  import type { Question } from '../Question';
3
3
  /**
4
- * A meta-question is a {@apilink Question} that can be answered
5
- * in the context of another {@apilink Answerable},
4
+ * A meta-question is a [`Question`](https://serenity-js.org/api/core/class/Question/) that can be answered
5
+ * in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable),
6
6
  * typically to transform its value.
7
7
  *
8
- * For example, the question {@apilink Text.of} can be answered in the context
9
- * of a {@apilink PageElement} to return its text content.
8
+ * For example, the question [`Text.of`](https://serenity-js.org/api/web/class/Text/#of) can be answered in the context
9
+ * of a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) to return its text content.
10
10
  *
11
- * {@apilink MetaQuestion|Meta questions} are typically used when filtering a {@apilink List}.
11
+ * [Meta-questions](https://serenity-js.org/api/core/interface/MetaQuestion/) are typically used when filtering a [`List`](https://serenity-js.org/api/core/class/List/).
12
12
  *
13
13
  * ## Learn more
14
- * - {@apilink List}
14
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
15
15
  *
16
16
  * @group Questions
17
17
  */
18
18
  export interface MetaQuestion<Supported_Context_Type, Returned_Question_Type extends Question<unknown>> {
19
19
  /**
20
- * Answers the given `MetaQuestion` in the context of another {@apilink Answerable}.
20
+ * Answers the given `MetaQuestion` in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable).
21
21
  *
22
22
  * #### Learn more
23
- * - {@apilink List}
23
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
24
24
  */
25
25
  of(context: Answerable<Supported_Context_Type>): Returned_Question_Type;
26
26
  /**
27
- * Human-readable description of this {@apilink MetaQuestion},
27
+ * Human-readable description of this [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/),
28
28
  * typically involving the description of the subject.
29
29
  *
30
30
  * For example, a description of a meta question obout "the text of an element"
@@ -3,8 +3,8 @@ import type { JSONValue } from 'tiny-types';
3
3
  import { TinyType } from 'tiny-types';
4
4
  import * as util from 'util';
5
5
  /**
6
- * A placeholder value signifying that a {@apilink Question}
7
- * has not been answered by an {@apilink Actor} when producing an {@apilink ExpectationOutcome}.
6
+ * A placeholder value signifying that a [`Question`](https://serenity-js.org/api/core/class/Question/)
7
+ * has not been answered by an [`Actor`](https://serenity-js.org/api/core/class/Actor/) when producing an [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/).
8
8
  * This happens when Serenity/JS decides that answering a given question
9
9
  * won't affect the outcome.
10
10
  *
@@ -27,8 +27,8 @@ exports.Unanswered = void 0;
27
27
  const tiny_types_1 = require("tiny-types");
28
28
  const util = __importStar(require("util")); // eslint-disable-line unicorn/import-style
29
29
  /**
30
- * A placeholder value signifying that a {@apilink Question}
31
- * has not been answered by an {@apilink Actor} when producing an {@apilink ExpectationOutcome}.
30
+ * A placeholder value signifying that a [`Question`](https://serenity-js.org/api/core/class/Question/)
31
+ * has not been answered by an [`Actor`](https://serenity-js.org/api/core/class/Actor/) when producing an [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/).
32
32
  * This happens when Serenity/JS decides that answering a given question
33
33
  * won't affect the outcome.
34
34
  *