externalMetaList <Supported_Context_Type, Item_Type>

Serenity/JS Screenplay Pattern-style wrapper around a ChainableMetaQuestion representing a collection that can be resolved in Supported_Context_Type of another Question.

For example, PageElements.located returns MetaList<PageElement>, which allows for the collection of page elements to be resolved in the context of dynamically-provided root element.

import { By, PageElements, PageElement } from '@serenity-js/web'

const firstLabel = () =>
  PageElements.located(By.css('label'))
     .first()
     .describedAs('first label')

const exampleForm = () =>
  PageElement.located(By.css('form#example1'))
     .describedAs('example form')

const anotherExampleForm = () =>
  PageElement.located(By.css('form#example2'))
     .describedAs('another example form')

// Next, you can compose the above questions dynamically with various "contexts":
//   firstLabel().of(exampleForm())
//   firstLabel().of(anotherExampleForm())

Hierarchy

• List<Item_Type>
  • MetaList

Implements

• ChainableMetaQuestion<Supported_Context_Type, MetaList<Supported_Context_Type, Item_Type>>

Index

Constructors

• constructor

Methods

• describedAs
• as
• describedBy
• toString
• forEach
• answeredBy
• of
• eachMappedTo
• where
• count
• first
• last
• nth

Constructors

externalconstructor

• new MetaList<Supported_Context_Type, Item_Type>(collection: Answerable<Item_Type[]> & ChainableMetaQuestion<Supported_Context_Type, Question<Promise<Item_Type[]>> | Question<Item_Type[]>>): MetaList<Supported_Context_Type, Item_Type>

• Overrides List.constructor

  Type parameters

  • Supported_Context_Type
  • Item_Type

  Parameters

  • externalcollection: Answerable<Item_Type[]> & ChainableMetaQuestion<Supported_Context_Type, Question<Promise<Item_Type[]>> | Question<Item_Type[]>>

  Returns MetaList<Supported_Context_Type, Item_Type>

Methods

externaldescribedAs

• describedAs(description: Answerable<string> | MetaQuestion<Item_Type[], Question<Promise<string>>>): this

• Inherited from List.describedAs

  Changes the description of this object, as returned by Describable.describedBy and Describable.toString.

  ---

  Parameters

  • externaldescription: Answerable<string> | MetaQuestion<Item_Type[], Question<Promise<string>>>

    Replaces the current description according to the following rules:

    • If description is an Answerable, it replaces the current description
    • If description is a MetaQuestion, the current description is passed as context to description.of(context), and the result replaces the current description

  Returns this

publicexternalas

• as<O>(mapping: (answer: Item_Type[]) => O | Promise<O>): QuestionAdapter<O>

• Inherited from List.as

  Maps this question to one of a different type.

  Question.about('number returned as string', actor => '42')   // returns: QuestionAdapter<string>
    .as(Number)                                                // returns: QuestionAdapter<number>

  ---

  Type parameters

  • O

  Parameters

  • externalmapping: (answer: Item_Type[]) => O | Promise<O>

  Returns QuestionAdapter<O>

externaldescribedBy

• describedBy(actor: AnswersQuestions & UsesAbilities & { name: string }): Promise<string>

• Inherited from List.describedBy

  Resolves the description of this object in the context of the provided actor.

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities & { name: string }

  Returns Promise<string>

externaltoString

• toString(): string

• Implementation of ChainableMetaQuestion.toString

  Inherited from List.toString

  Returns a human-readable description of this object.

  ---

  Returns string

externalforEach

• forEach(callback: (current: CurrentItem<Item_Type>, index: number, items: Item_Type[]) => void | Promise<void>): Task

• Inherited from List.forEach

  Parameters

  • externalcallback: (current: CurrentItem<Item_Type>, index: number, items: Item_Type[]) => void | Promise<void>

  Returns Task

externalansweredBy

• answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<Item_Type[]>

• Inherited from List.answeredBy

  Instructs the provided Actor to use their abilities to answer this question.

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities

  Returns Promise<Item_Type[]>

externalof

• of(context: Answerable<Supported_Context_Type>): MetaList<Supported_Context_Type, Item_Type>

• Implementation of ChainableMetaQuestion.of

  Answers the given ChainableMetaQuestion in the context of another Answerable and returns another ChainableMetaQuestion ready for further chaining.

  Learn more

  • List

  ---

  Parameters

  • externalcontext: Answerable<Supported_Context_Type>

  Returns MetaList<Supported_Context_Type, Item_Type>

externaleachMappedTo

• eachMappedTo<Mapped_Item_Type>(question: MetaQuestion<Item_Type, Question<Mapped_Item_Type | Promise<Mapped_Item_Type>>>): MetaList<Supported_Context_Type, Mapped_Item_Type>

• Overrides List.eachMappedTo

  Type parameters

  • Mapped_Item_Type

  Parameters

  • externalquestion: MetaQuestion<Item_Type, Question<Mapped_Item_Type | Promise<Mapped_Item_Type>>>

  Returns MetaList<Supported_Context_Type, Mapped_Item_Type>

externalwhere

• where<Answer_Type>(question: MetaQuestion<Item_Type, Question<Answer_Type | Promise<Answer_Type>>>, expectation: Expectation<Answer_Type>): MetaList<Supported_Context_Type, Item_Type>

• Overrides List.where

  Type parameters

  • Answer_Type

  Parameters

  • externalquestion: MetaQuestion<Item_Type, Question<Answer_Type | Promise<Answer_Type>>>

  • externalexpectation: Expectation<Answer_Type>

  Returns MetaList<Supported_Context_Type, Item_Type>

externalcount

• count(): MetaQuestionAdapter<Supported_Context_Type, number>

• Overrides List.count

  Returns MetaQuestionAdapter<Supported_Context_Type, number>

externalfirst

• first(): MetaQuestionAdapter<Supported_Context_Type, Item_Type>

• Overrides List.first

  Returns MetaQuestionAdapter<Supported_Context_Type, Item_Type>

externallast

• last(): MetaQuestionAdapter<Supported_Context_Type, Item_Type>

• Overrides List.last

  Returns MetaQuestionAdapter<Supported_Context_Type, Item_Type>

externalnth

• nth(index: number): MetaQuestionAdapter<Supported_Context_Type, Item_Type>

• Overrides List.nth

  Parameters

  • externalindex: number

  Returns MetaQuestionAdapter<Supported_Context_Type, Item_Type>