Class Screen

Get a specified state for page. A mode operator must be prepended.

Hierarchy

  • Question<boolean>
    • Screen

Properties

abilityAlias? callStack?

Accessors

not does

Methods - Factory

of

Methods - Other

addToCallStack setCallStackInitializeCalledWith withAbilityAlias

Methods - called internally

answeredBy

Methods - mode operators

haveScreenshot haveTitle haveUrl

Properties

Optional abilityAlias

abilityAlias?: string

Optional callStack

callStack?: CallStackInfo[]

Accessors

not

  • get not(): this

  • make the Question check for the negative.

    Returns this

    new Screen instance

    Example: Verify with Element class.

    actor.asks(
     Screen.does.not.haveURL("https://example.com")
    );

Static does

  • get does(): Screen

  • make the verifying for the positive.

    Returns Screen

    new Screen instance

    Example: Verify with Screen class.

    actor.asks(
     Screen.does.haveUrl("https://example.com")
    );

Methods - Factory

Static of

Methods - Other

addToCallStack

  • addToCallStack(entry): void

  • Parameters

    • entry: CallStackInfo

    Returns void

setCallStackInitializeCalledWith

  • setCallStackInitializeCalledWith(calledWith): void

  • Parameters

    • calledWith: CallStackCalledWith

    Returns void

withAbilityAlias

  • withAbilityAlias(alias): this

  • Set the alias which is used for an underlying ability

    Parameters

    • alias: undefined | string

      with which an ability was initialized

    Returns this

    current action

Methods - called internally

answeredBy

  • answeredBy(actor): Promise<boolean>

  • Verifies if an element.

    Parameters

    • actor: Actor

      the actor

    Returns Promise<boolean>

    true if the element has the specified state, false otherwise.

Methods - mode operators

haveScreenshot

  • haveScreenshot(name, options?): Screen

  • Verifies if the page has URL.

    Parameters

    • name: string | string[]

      the screenshot name.

    • Optional options: {
          timeout?: number;
      }

      the timeout in milliseconds.

      • Optional timeout?: number

    Returns Screen

    this Screen instance

    Example

    simple call with just locator

    Screen.toHaveScreenshot('example.png');

    with options

    Screen.not.toHaveScreenshot(
      'example.png',
      { timeout: 1000 }
    );

haveTitle

  • haveTitle(title, options?): Screen

  • Verifies if the page has URL.

    Parameters

    • title: string | RegExp
    • Optional options: {
          timeout?: number;
      }

      the timeout in milliseconds.

      • Optional timeout?: number

    Returns Screen

    this Screen instance

    Example

    simple call with just locator

    Screen.toHaveTitle('Title');

    with options

    Screen.not.toHaveTitle(
      'Title',
      { timeout: 1000 }
    );

haveUrl

  • haveUrl(url, options?): Screen

  • Verifies if the page has URL.

    Parameters

    • url: string | RegExp

      the expected URL.

    • Optional options: {
          timeout?: number;
      }

      the timeout in milliseconds.

      • Optional timeout?: number

    Returns Screen

    this Screen instance

    Example

    simple call with just locator

    Screen.toHaveUrl('https://www.example.com');

    with options

    Screen.not.toHaveUrl('https://www.example.com', { timeout: 1000 });

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc