externalabstractList <Item_Type>

Serenity/JS Screenplay Pattern-style wrapper around Array and array-like structures - see PageElement.

Hierarchy

• Question<Promise<Item_Type[]>>
  • List
    • MetaList

Index

Constructors

• constructor

Methods

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

Screenplay Pattern

• as

Constructors

externalconstructor

• new List<Item_Type>(collection: Answerable<Item_Type[]>): List<Item_Type>

• Overrides Question<Promise<Array<Item_Type>>>.constructor

  Type parameters

  • Item_Type

  Parameters

  • externalcollection: Answerable<Item_Type[]>

  Returns List<Item_Type>

Methods

staticexternalof

• of<IT, CT, RQT>(collection: Answerable<IT[]> & ChainableMetaQuestion<CT, RQT>): MetaList<CT, IT>
• of<IT>(collection: Answerable<IT[]>): List<IT>

• Type parameters

  • IT
  • CT
  • RQT: Question<Promise<IT[]>> | Question<IT[]>

  Parameters

  • externalcollection: Answerable<IT[]> & ChainableMetaQuestion<CT, RQT>

  Returns MetaList<CT, IT>

externaldescribedAs

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

• Inherited from Question.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

externaldescribedBy

• describedBy(actor: AnswersQuestions & UsesAbilities & HasName): Promise<string>

• Inherited from Question.describedBy

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

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities & HasName

  Returns Promise<string>

externaltoString

• toString(): string

• Inherited from Question.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

• Parameters

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

  Returns Task

externalabstracteachMappedTo

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

• Type parameters

  • Mapped_Item_Type

  Parameters

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

  Returns List<Mapped_Item_Type>

externalabstractwhere

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

• Parameters

  • externalexpectation: Expectation<Item_Type>

  Returns List<Item_Type>

externalabstractcount

• count(): QuestionAdapter<number>

• Returns QuestionAdapter<number>

externalabstractfirst

• first(): QuestionAdapter<Item_Type>

• Returns QuestionAdapter<Item_Type>

externalabstractlast

• last(): QuestionAdapter<Item_Type>

• Returns QuestionAdapter<Item_Type>

externalabstractnth

• nth(index: number): QuestionAdapter<Item_Type>

• Parameters

  • externalindex: number

  Returns QuestionAdapter<Item_Type>

externalansweredBy

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

• Overrides Question.answeredBy

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

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities

  Returns Promise<Item_Type[]>

Screenplay Pattern

publicexternalas

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

• Inherited from Question.as

  Maps this question's resolved answer to a QuestionAdapter of a different type.

  Provide a function to transform the resolved answer:

  import { Question } from '@serenity-js/core'
  
  const number = Question.about('number returned as text', () => '42')
    .as(Number)
  
  const name = Question.about('name with whitespace', () => ' Alice ')
    .as(value => value.trim())
  
  const firstValue = Question.about('available values', () => ['first', 'second'])
    .as(values => values[0])

  Alternatively, provide a constructor. When you call .as(MyClass), Serenity/JS passes the resolved answer as MyClass's sole constructor argument. This is particularly useful when wrapping a mounted UI component in an Interaction Object for component testing:

  const card = story('components/UserCard/Default', { name: 'Alice' }).as(UserCard)

  To distinguish a mapping function from a constructor, Serenity/JS calls the mapping as a function first. If that throws a TypeError and the mapping has a prototype (indicating an ES6 class), Serenity/JS retries with new. This preserves the primitive result of Number(42), rather than producing a Number wrapper object.

  Learn more

  • Component testing with Playwright Test

  ---

  Type parameters

  • O

  Parameters

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

    A function that transforms the resolved answer, or a constructor that receives it as its sole argument.

  Returns QuestionAdapter<O>

  A QuestionAdapter that resolves to the mapped answer.