externalSend

Sends a HTTPRequest to a specified URL.

The response to the request is made available via LastResponse.

Send a GET request

import { actorCalled } from '@serenity-js/core'
import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
import { Ensure, equals } from '@serenity-js/assertions'

await actorCalled('Apisitt')
  .whoCan(CallAnApi.at('https://api.example.org/'))
  .attemptsTo(
    Send.a(GetRequest.to('/books/0-688-00230-7')),
    Ensure.that(LastResponse.status(), equals(200)),
  )

Hierarchy

• Interaction
  • Send

Index

Methods

• a
• instantiationLocation
• describedBy
• toString
• performAs

Methods

staticexternala

• a(request: Answerable<AxiosRequestConfig<any>>): Interaction

• Instantiates a new interaction to Send.

  Learn more

  • AxiosRequestConfig

  ---

  Parameters

  • externalrequest: Answerable<AxiosRequestConfig<any>>

  Returns Interaction

externalinstantiationLocation

• instantiationLocation(): FileSystemLocation

• Inherited from Interaction.instantiationLocation

  Returns the location where this Activity was instantiated.

  ---

  Returns FileSystemLocation

externaldescribedBy

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

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

  Returns a human-readable description of this object.

  ---

  Returns string

externalperformAs

• performAs(actor: UsesAbilities & CollectsArtifacts & AnswersQuestions): Promise<void>

• Overrides Interaction.performAs

  @inheritDoc

  ---

  Parameters

  • externalactor: UsesAbilities & CollectsArtifacts & AnswersQuestions

  Returns Promise<void>