reporting.checks
Display actionable real-time checks for a Report.
buffer()
buffer(
args
):void
Add a check to the buffer. Once you've finished adding checks to the buffer, send the checks to the Report Editor.
Parameters
Parameter | Type | Description |
---|---|---|
args | object | - |
args.fixes ? | CheckFixBuffered [] | Optional fixes that can be applied to the check. |
args.id | string | A unique identifier for this check. If another check uses the same id, the last check to be buffered will be used. |
args.level | "info" | "warning" | "error" | The level of severity of this check. |
args.message | string | An explanation of the check. |
args.positions ? | Position [] | Optional positions in the Report Editor where the issue(s) appear. Positions enable inline highlighting of the checks within the Report Editor. |
Returns
void
send()
send():
void
Display all buffered checks. Existing checks from this extension will be cleared.
Returns
void