@pageobject/base
Options
All
  • Public
  • Public/Protected
  • All
Menu

@pageobject/base

Package Version Build Status Coverage Status TypeScript

A declarative API as a basis for platform- and framework-independent UI test automation.

This package is part of PageObjectJS.

Installation

yarn add @pageobject/base

API documentation

Please find the API documentation here.

Copyright (c) 2017-present, Clemens Akens. Released under the terms of the MIT License.

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

ConditionalTestCallback

ConditionalTestCallback: function

Type declaration

    • (thenTest: Test, elseTest: Test): void

    • Parameters

      Returns void

Effect

Effect: function

Type declaration

    • (): Promise<TResult>

    • Returns Promise<TResult>

TestCallback

TestCallback: function

Type declaration

    • (test: Test, context: TContext): void

    • Parameters

      • test: Test
      • context: TContext

      Returns void

TestStep

TestStep: function

Type declaration

Functions

reliable

  • reliable(testStep: TestStep, retryOnError: boolean, timeoutInSeconds: number, customMessage?: undefined | string): TestStep

  • Parameters

    • testStep: TestStep
    • retryOnError: boolean
    • timeoutInSeconds: number
    • Optional customMessage: undefined | string

    Returns TestStep

runAll

  • runAll(testSteps: TestStep[]): Promise<void>

serialize

  • serialize(value: any): string

useJest

  • useJest(): boolean