Skip to main content

Class: CheckGroup

Extends​

  • BaseClient

Constructors​

Constructor​

new CheckGroup(ctx?, _id?): CheckGroup

Constructor is used for internal usage only, do not create object from it.

Parameters​

ctx?​

Context

_id?​

ID

Returns​

CheckGroup

Overrides​

BaseClient.constructor

Methods​

id()​

id(): Promise<ID>

A unique identifier for this CheckGroup.

Returns​

Promise<ID>

list()​

list(): Promise<Check[]>

Return a list of individual checks and their details

Returns​

Promise<Check[]>

report()​

report(): File

Generate a markdown report

Returns​

File

run()​

run(opts?): CheckGroup

Execute all selected checks

Parameters​

opts?​

CheckGroupRunOpts

Returns​

CheckGroup

with()​

with(arg): CheckGroup

Call the provided function with current CheckGroup.

This is useful for reusability and readability by not breaking the calling chain.

Parameters​

arg​

(param) => CheckGroup

Returns​

CheckGroup