Class Check

source · [−]
Expand description

Check, when run it returns good or bad.

Constructors

constructor

source

new (id: string): Check

All elements have an id associated to encourage short unique ids for all elements.

Properties

Cached renders.

String of text shown on expand or on hover that gives more details.

Fail text, should explain how to resolve issue.

Internal id used in filesystem refs and urls so no spaces or nasty chars please. Please set this yourself if possible.

How eye attracting a check should be.

Current state of the element.

Success text. Should explain why something is good if you want.

Title, this should make it really clear what the element is about.

Should render a check or cross emoji depending on status in report?

Methods

source

_init

source

(): Promise<void>

Overridable universal element initialization implementation.

source

_render

source

(renderer: Renderer): Promise<string>

Overridable render implementation. Results from this must not be cached.

source

_run

source

(): Promise<void>

Overridable universal elememnt execution implementation.

source

(): Promise<boolean>

Internal implementation of the check.

source

(): boolean

source

(): Element[]

source

(): Promise<void>

source

(renderer: Renderer): Promise<string>

User-facing render implementation.

source

(): Promise<void>

Universal method applicable to all elements for executing their functions. DO NOT OVERRIDE. Please override _run instead which is called internally.

source

(ctx: Context): Promise<void>

source

(description: string): Check

source

(failureInfo: string): Check

source

(inverted?: boolean): Check

Invert the results. For example if the check is to check if a package is installed inverting it will make sure is not.

source

(remediation: Script): Check

Set remediation to run on apply mode.

source

(severity: number): Check

source

(successInfo: string): Check

source

(title: string): Check

source

(useEmoji?: boolean): Check