externalPageElementsLocator <Native_Element_Type>

Hierarchy

• Question<Promise<PageElement<Native_Element_Type>[]>>
  • PageElementsLocator

Implements

• ChainableMetaQuestion<PageElement<Native_Element_Type>, Question<Promise<PageElement<Native_Element_Type>[]>>>

Index

Constructors

• constructor

Methods

• fromDocumentRoot
• describedAs
• describedBy
• toString
• of
• answeredBy

Screenplay Pattern

• as

Constructors

externalconstructor

• new PageElementsLocator<Native_Element_Type>(locator: Answerable<Locator<Native_Element_Type, any>>): PageElementsLocator<Native_Element_Type>

• Overrides Question<Promise<Array<PageElement<Native_Element_Type>>>>.constructor

  Type parameters

  • Native_Element_Type = any

  Parameters

  • externallocator: Answerable<Locator<Native_Element_Type, any>>

  Returns PageElementsLocator<Native_Element_Type>

Methods

staticexternalfromDocumentRoot

• fromDocumentRoot<NET>(selector: Answerable<Selector>): PageElementsLocator<NET>

• Type parameters

  • NET

  Parameters

  • externalselector: Answerable<Selector>

  Returns PageElementsLocator<NET>

externaldescribedAs

• describedAs(description: Answerable<string> | MetaQuestion<PageElement<Native_Element_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<PageElement<Native_Element_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 & { name: string }): Promise<string>

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

  Returns a human-readable description of this object.

  ---

  Returns string

externalof

• of(parent: Answerable<PageElement<Native_Element_Type>>): Question<Promise<PageElement<Native_Element_Type>[]>> & ChainableMetaQuestion<PageElement<Native_Element_Type>, Question<Promise<PageElement<Native_Element_Type>[]>>>

• Implementation of ChainableMetaQuestion.of

  Parameters

  • externalparent: Answerable<PageElement<Native_Element_Type>>

  Returns Question<Promise<PageElement<Native_Element_Type>[]>> & ChainableMetaQuestion<PageElement<Native_Element_Type>, Question<Promise<PageElement<Native_Element_Type>[]>>>

externalansweredBy

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

• Overrides Question.answeredBy

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities

  Returns Promise<PageElement<Native_Element_Type>[]>

Screenplay Pattern

externalas

• as<O>(mapping: (answer: PageElement<Native_Element_Type>[]) => O | Promise<O>): QuestionAdapter<O>
• as<O>(mapping: new (answer: PageElement<Native_Element_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: PageElement<Native_Element_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.