Check
API reference
Implements Node
checkType- The type of check: 'check' for annotated checks, 'generate' for generate-as-checks
completed- Whether the check completed
description- The description of the check
id- A unique identifier for this Check.
name- Return the fully qualified name of the check
passed- Whether the check passed
path- The path of the check within its module
resultEmoji- An emoji representing the result of the check
error- If the check failed, this is the error
originalModule- The original module in which the check has been defined
run- Execute the check
checkType: String!
The type of check: 'check' for annotated checks, 'generate' for generate-as-checks
completed: Boolean!
Whether the check completed
description: String!
The description of the check
id: ID!
A unique identifier for this Check.
name: String!
Return the fully qualified name of the check
passed: Boolean!
Whether the check passed
path: [String!]!
The path of the check within its module
resultEmoji: String!
An emoji representing the result of the check
originalModule: Module!
The original module in which the check has been defined