externalabstractHTTPRequest

HTTP Request sent by the Actor using the interaction to Send

Hierarchy

• Question<Promise<AxiosRequestConfig>>
  • HTTPRequest
    • DeleteRequest
    • GetRequest
    • HeadRequest
    • OptionsRequest
    • PatchRequest
    • PostRequest
    • PutRequest

Index

Methods

• describedAs
• describedBy
• toString
• answeredBy

Screenplay Pattern

• as

Methods

externaldescribedAs

• describedAs(description: Answerable<string> | MetaQuestion<AxiosRequestConfig<any, any>, 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<AxiosRequestConfig<any, any>, 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

• Inherited from Question.toString

  Returns a human-readable description of this object.

  ---

  Returns string

externalansweredBy

• answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<AxiosRequestConfig<any, any>>

• Overrides Question.answeredBy

  @inheritDoc

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities

  Returns Promise<AxiosRequestConfig<any, any>>

Screenplay Pattern

externalas

• as<O>(mapping: (answer: AxiosRequestConfig<any, any>) => O | Promise<O>): QuestionAdapter<O>
• as<O>(mapping: new (answer: AxiosRequestConfig<any, any>) => 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: AxiosRequestConfig<any, any>) => 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.