Options
All
  • Public
  • Public/Protected
  • All
Menu

wdio-workflo

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

CloneFunc

CloneFunc: function

A function used to clone a PageElementList.

template

Type the type of the cloned list

param

the selector of the cloned list

Type declaration

    • (selector?: XPath): Type
    • Parameters

      • Optional selector: XPath

      Returns Type

ElementNode

ElementNode: IElementNode<ExtractText<Content> | ExtractTextStateChecker<Content>, ExtractBoolean<Content> | ExtractBooleanStateChecker<Content>, IGroupFilterMask<Content>>

This interface is implemented by PageElement, PageElementList, PageElementMap and PageElementGroup.

IElementNode guarantees support of the following state retrieval functions:

  • getIsEnabled
  • getText
  • getDirectText
  • getHasText
  • getHasAnyText
  • getContainsText
  • getHasDirectText
  • getHasAnyDirectText
  • getContainsDirectText

IElementNode guarantees support of the following state check functions:

  • exists
  • isVisible
  • isEnabled
  • hasText
  • hasAnyText
  • containsText
  • hasDirectText
  • hasAnyDirectText
  • containsDirectText

ExtractBoolean

ExtractBoolean: ExtractBoolean<Content>

Extracts the return value types of the getIsEnabled functions of all PageNodes defined within a PageElementGroup's content. For a PageElement, the extract return value type will be boolean.

ExtractBooleanStateChecker

ExtractBooleanStateChecker: ExtractBooleanStateChecker<Content>

Extracts the return value types of the getIsEnabled functions of all PageNodes defined within a PageElementGroup's content for state check functions. For a PageElement, the extracted return value type will be boolean. Compared to ExtractBoolean, this will allow the a PageElementList to pass either a single boolean or an array of booleans.

ExtractText

ExtractText: ExtractText<Content>

Extracts the return value types of the getText functions of all PageNodes defined within a PageElementGroup's content. For a PageElement, the extract return value type will be string.

ExtractTextStateChecker

ExtractTextStateChecker: ExtractTextStateChecker<Content>

Extracts the return value types of the getText functions of all PageNodes defined within a PageElementGroup's content for state check functions. For a PageElement, the extracted return value type will be string. Compared to ExtractText, this will allow a PageElementList to pass either a single string or an array of strings.

ExtractValue

ExtractValue: ExtractValue<Content>

Extracts the return value types of the getValue functions of all PageNodes defined within a ValuePageElementGroup's content.

ExtractValueBoolean

ExtractValueBoolean: ExtractValueBoolean<Content>

Extracts the return value types of the getHasValue functions of all PageNodes defined within a ValuePageElementGroup's content. For a ValuePageElement, the return value type will be boolean.

ExtractValueStateChecker

ExtractValueStateChecker: ExtractValueStateChecker<Content>

Extracts the return value types of the getValue functions of all PageNodes defined within a ValuePageElementGroup's content for state check functions and the setValue function. Compared to ExtractValue, this will allow ta PageElementList to pass either a single value or an array of values.

IOptStepParams

IOptStepParams: IOptStepParams<ArgsType, ReturnType>

IOptStepParams are supposed to be used as the parameters of a step creation function if a step does not require any or only optional arguments.

template

ArgsType defines the type of the step arguments passed to the execution function.

template

ReturnType defines the return type of the execution function.

IStep

IStep: IStep

Steps consist of a description and an execution function. The execution function performs changes to the state of the tested application and the description briefly summarizes these changes in natural language.

A step can be parameterized by passing step arguments and a step callback (both of which are optional) to the execution function:

Step arguments are key-value pair objects that provide dynamic values to the state changes of the execution function. They also enable the interpolation of a step's description by replacing %{key} in the description string with key's value retrieved from the step arguments object).

Step callbacks can be used to query and validate the state of the tested application right after step execution. A step callback will be passed the return value of the execution function as its first parameter.

IStepParams

IStepParams: IStepParams<ArgsType, ReturnType>

IStepParams are supposed to be used as the parameters of a step creation function if a step requires mandatory step arguments.

template

ArgsType defines the type of the step arguments passed to the execution function.

template

ReturnType defines the return type of the execution function.

Severity

Severity: Severity

Severity describes how severe the implications of something not working correctly would be.

SpecStatus

SpecStatus: SpecStatus

The result status of a validation/an acceptance criteria of a Story.

StepDefinitions

StepDefinitions: StepDefinitions

Steps in wdio-workflo need to be defined in this format - on object where the keys are the step descriptions and the values are step creation functions that take the step parameters as and argument and return a created Step.

TestcaseStatus

TestcaseStatus: TestcaseStatus

The result status of a testcase.

ValueElementNode

ValueElementNode: IValueElementNode<ExtractValue<Content> | ExtractValueStateChecker<Content>, IValueGroupFilterMask<Content>>

This interface is implemented by ValuePageElement, ValuePageElementList, ValuePageElementMap and ValuePageElementGroup.

IValueElementNode guarantees support of the following state retrieval functions:

  • getValue
  • getHasValue
  • getHasAnyValue
  • getContainsValue

IValueElementNode guarantees support of the following state check functions:

  • hasValue
  • hasAnyValue
  • containsValue

Variables

Const DEFAULT_INTERVAL

DEFAULT_INTERVAL: 500 = 500

The default interval value used in functions that operate with intervals if no other interval is specified in workflo.conf.ts, in the PageNode itself or as a parameter passed to the function.

Const DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: 5000 = 5000

The default timeout value used in functions that operate with timeouts if no other timeout is specified in workflo.conf.ts, in the PageNode itself or as a parameter passed to the function.

Const pageNode

pageNode: PageNodeStore = new PageNodeStore()

Functions

applyMixins

  • applyMixins(derivedCtor: any, baseCtors: any[], mergeObjectKeys?: string[]): void
  • Mixes baseCtors classes into derivedCtor class. All properties of baseCtors will be written to derivedCtor. If a property with the same name already exists in derivedCtor, it will be overwritten. For more information about typescript mixins see https://www.typescriptlang.org/docs/handbook/mixins.html

    Parameters

    • derivedCtor: any

      the class into which baseCtors should be mixed in

    • baseCtors: any[]

      the classes which should be mixed into derivedCtor

    • Default value mergeObjectKeys: string[] = []

      If the name of property is contained in mergeObjectKeys and the property exists as an object in both derivedCtor and baseCtor, both objects will be merged together instead of the baseCtor object overwriting the derivedCtor object. Be aware that deep merging is not supported and therefore "nested" properties with the same name in derivedCtor's object and baseCtor's object will still be overwritten by baseCtor's object values.

    Returns void

defineSteps

  • defineSteps<StepDefinitions>(stepDefinitions: StepDefinitions): StepDefinitions
  • Use this function to create step definitions and preserve their types.

    Type parameters

    Parameters

    • stepDefinitions: StepDefinitions

      An object whose keys are step descriptions and whose values are step creation functions.

    Returns StepDefinitions

isEmpty

  • isEmpty(value: any): boolean
  • Returns true if:

    • value is undefined
    • value is null
    • value is a string and length of value is 0

    Parameters

    • value: any

      an arbitrary value

    Returns boolean

isIElementNode

isIValueElementNode

isJsError

  • isJsError(result: any): boolean

isNullOrUndefined

  • isNullOrUndefined(value: any): boolean
  • Returns true if value is null or undefined.

    Parameters

    • value: any

      an arbitrary value

    Returns boolean

notIsNullOrUndefined

  • notIsNullOrUndefined(value: any): boolean
  • Returns true if value is neither null nor undefined.

    Parameters

    • value: any

      an arbitrary value

    Returns boolean

proxifySteps

  • proxifySteps<StepDefinitions>(stepDefinitions: StepDefinitions): StepDefinitions
  • Creates a Proxy that adds custom getters and setters to the merged step definitions. Steps in wdio-workflo can only function properly if this proxy is used to interact with them.

    Type parameters

    Parameters

    • stepDefinitions: StepDefinitions

      the merged step definitions

    Returns StepDefinitions

    the proxified steps

tolerancesToString

  • tolerancesToString(values: number | Record<string, number>, tolerances?: number | Record<string, number>): string | number
  • Prints values with tolerances as a string.

    Parameters

    • values: number | Record<string, number>

      a number or an object with values of type number

    • Optional tolerances: number | Record<string, number>

      a number or an object with values of type number

    Returns string | number

Generated using TypeDoc