Check
class Check extends AbstractObject implements IdAble, Node
Properties
| $lastQuery | from AbstractObject |
Methods
No description
The type of check: 'check' for annotated checks, 'generate' for generate-as-checks
Whether the check completed
The description of the check
If the check failed, this is the error
Return the fully qualified name of the check
The original module in which the check has been defined
Whether the check passed
The path of the check within its module
An emoji representing the result of the check
Details
in
AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 16
string
checkType()
The type of check: 'check' for annotated checks, 'generate' for generate-as-checks
at line 25
bool
completed()
Whether the check completed
at line 34
string
description()
The description of the check
at line 43
Error|null
error()
If the check failed, this is the error
at line 57
Id
id()
A unique identifier for this Check.
at line 66
string
name()
Return the fully qualified name of the check
at line 75
Module
originalModule()
The original module in which the check has been defined
at line 84
bool
passed()
Whether the check passed
at line 93
array
path()
The path of the check within its module
at line 102
string
resultEmoji()
An emoji representing the result of the check
at line 111
Check
run()
Execute the check