#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

Constructors - API calls which return an object, typically one that offers API methods

Methods - API calls which can only be made on an object returned by a constructor


Signature	`cp.rx.go.WaitUntil.Are <cp.rx.go.Statement.Modifier>`
Type	Constant
Description	A `Statement.Modifier` that sets the values to match.
Notes	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 61


Signature	`cp.rx.go.WaitUntil.AreNot <cp.rx.go.Statement.Modifier>`
Type	Constant
Description	A `Statement.Modifier` that sets a value to skip over.
Notes	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 94


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.
Notes	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 47


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.
Notes	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 80


Signature	`cp.rx.go.WaitUntil.Matches <cp.rx.go.Statement.Modifier>`
Type	Constant
Description	A `Statement.Modifier` that sets a predicate check values against.
Notes	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 113


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.
Notes	By default, it will wait until the value is `truthy` - not `nil` and not `false`. Example: `lua</li><li>WaitUntil(someObservable):Is(true)</li><li>`
Examples	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 15


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`.
Notes	None
Examples	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 65


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`.
Notes	None
Examples	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 98


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`.
Notes	None
Examples	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 51


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`.
Notes	None
Examples	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 84


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`.
Notes	* Example: `lua</li><li>WaitUntil(someObservable):Matches(function(value) return value % 2 == 0 end)</li><li>`
Examples	None
Source	src/extensions/cp/rx/go/WaitUntil.lua line 117