Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Interaction<T>

An interaction represents some type of action or assertion that can be taken on an Interactor.

The interaction can function as a lazy promise. That means that calling then on the interaction or awaiting it using await, will run the interaction and the promise will resolve once the action is complete. However, an interaction which is not awaited will not run by itself.

Type parameters

  • T

    the return value of the promise that this interaction evaluates to.

Hierarchy

Index

Properties

Methods

Properties

[interactionSymbol]

[interactionSymbol]: true

Readonly [toStringTag]

[toStringTag]: string

description

description: string

Return a description of the interaction

Methods

action

  • action(): Promise<T>

  • Perform the interaction

    Returns Promise<T>

catch

  • catch<TResult>(onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>)): Promise<T | TResult>

  • Attaches a callback for only the rejection of the Promise.

    Type parameters

    • TResult = never

    Parameters

    • Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<T | TResult>

    A Promise for the completion of the callback.

finally

  • finally(onfinally?: null | (() => void)): Promise<T>

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optional onfinally: null | (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<T>

    A Promise for the completion of the callback.

then

  • then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type parameters

    • TResult1 = T

    • TResult2 = never

    Parameters

    • Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Generated using TypeDoc