Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
107 lines (89 loc) · 8.28 KB

cp.rx.go.WaitUntil.md

File metadata and controls

107 lines (89 loc) · 8.28 KB
Raw

docs » cp.rx.go.WaitUntil

A Statement that will wait for the first value from a resolveable that matches the predicate.

API Overview

  • Constants - Useful values which cannot be changed
  • Are
  • AreNot
  • Is
  • IsNot
  • Matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • WaitUntil
  • Methods - API calls which can only be made on an object returned by a constructor
  • Are
  • AreNot
  • Is
  • IsNot
  • Matches

API Documentation

Constants

Are

Signature cp.rx.go.WaitUntil.Are <cp.rx.go.Statement.Modifier>
Type Constant
Description A Statement.Modifier that sets the values to match.

AreNot

Signature cp.rx.go.WaitUntil.AreNot <cp.rx.go.Statement.Modifier>
Type Constant
Description A Statement.Modifier that sets a value to skip over.

Is

Signature cp.rx.go.WaitUntil.Is <cp.rx.go.Statement.Modifier>
Type Constant
Description A Statement.Modifier that sets a specific value to wait for.

IsNot

Signature cp.rx.go.WaitUntil.IsNot <cp.rx.go.Statement.Modifier>
Type Constant
Description A Statement.Modifier that sets a value that is skipped over.

Matches

Signature cp.rx.go.WaitUntil.Matches <cp.rx.go.Statement.Modifier>
Type Constant
Description A Statement.Modifier that sets a predicate check values against.

Constructors

WaitUntil

Signature cp.rx.go.WaitUntil(requirement) -> WaitUntil
Type Constructor
Description Creates a new WaitUntil Statement with the specified requirement.
Parameters
  • requirement - a resolvable value that will be checked.
Returns
  • The Statement instance which will check if the resolvable matches the requirement.

Methods

Are

Signature cp.rx.go.WaitUntil:Are(value) -> WaitUntil.Are
Type Method
Description Specifies the value to check.
Parameters
  • value - The value to wait for.
Returns
  • The Are Statement.Modifier.

AreNot

Signature cp.rx.go.WaitUntil:AreNot(value) -> WaitUntil.AreNot
Type Method
Description Specifies the value to skip over.
Parameters
  • value - The value to skip over.
Returns
  • The AreNot Statement.Modifier.

Is

Signature cp.rx.go.WaitUntil:Is(value) -> WaitUntil.Is
Type Method
Description Specifies the value to check.
Parameters
  • value - The value to wait for.
Returns
  • The Is Statement.Modifier.

IsNot

Signature cp.rx.go.WaitUntil:IsNot(value) -> WaitUntil.IsNot
Type Method
Description Specifies the value to skip.
Parameters
  • value - The value to skip over.
Returns
  • The IsNot Statement.Modifier.

Matches

Signature cp.rx.go.WaitUntil:Matches(predicate) -> WaitUntil.Matches
Type Method
Description Specifies the predicate function that will check the requirement results.
Parameters
  • predicate - The function that will get called to determine if it has been found.
Returns
  • The Matches Statement.Modifier.