Class Case

source · [−]
Expand description

Each use case for the tool should be declared as case which is a chain of elements (ideally groups and checks). Examples include "Ubuntu 22.04", "Fedora 36", "Windows", "CIS Benchmark Compilance", "System security check", and "Sanity Check"

Constructors

constructor

source

new (id: string): Case

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.

Internal element list.

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

Current state of the element.

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

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

(element: Element): Case

Chainable add element to case method.

source

(group: Group): Case

Copy all the elements from a group. Useful if you don't want one group nested inside another.

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): Case

source

(title: string): Case