Skip to main content

UseKinesis

The UseKinesis class is part of a testing library built on top of AWS Kinesis, implementing the Screenplay pattern.

Extends​

This class extends the abstract Ability class from Core.

Methods​

getClient​

Introduced in: 1.0.0

public getClient(): KinesisClient
  • Description: Get the kinesis client associated with this instance.
  • Returns: KinesisClient - The AWS kinesis client.

Usage:

// inside an actions performAs method
const kinesisClient = UseKinesis.as(actor, this.abilityAlias).getClient();
// now you can use the client

using​

public static using(settings: AwsSettings): UseKinesis
  • Description: Initialize the UseKinesis ability by passing an AwsSettings object.
  • Parameters:
    • settings - The AWS Settings.
  • Returns: UseKinesis - The initialized UseKinesis object.

Usage:

actor.can(UseKinesis.using(settings))

as​

public static as(actor: Actor, alias?: string): UseKinesis
  • Description: Use this ability as an actor.
  • Parameters:
    • actor - The actor object.
    • alias - (Optional) The alias for the ability
  • Returns: UseKinesis - The ability to use Kinesis as the actor, optionally with an alias name.

Methods inherited from Core Ability​

withAlias​

Introduced in core: 0.3.0

public withAlias(alias: string): Ability;
  • Description: Defines the ability's alias.
  • Parameters:
    • alias - The alias.
  • Returns: Ability - Returns the current ability.

Usage:

Actor.can(Ability.withAlias('aliased'));