@rbxts/expect > ActualPlaceholder
ActualPlaceholder interface
The "actual" variable in an expect() statement.
Signature:
interface ActualPlaceholder
Remarks
This is the first variable passed into expect() when starting an assertion chain.
We refer to it as the "actual" variable, as it's a contrast to the expected variable.
Note that you shouldn't use actual
directly in your messages, instead you should use one of the properties of this type.
Example
Given the following assertion chain:
expect(5).to.equal(6);
The value 5
is the "actual" value/variable.
It's whatever you pass to expect
when calling it initially.
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
string | The "actual" value in an expect() statement, which is not collapsed. | ||
string | A string representing the type of the actual value in an expect() statement. | ||
string | The "actual" value in an expect() statement, which can optionally be collapsed. |