Interface ValidateReport

The report on an index.

Example

const report: ValidateReport = await pluginIndex_validate(index, { offline: true });
report.ok;

interface ValidateReport {
    commit: string | null;
    descriptors: number;
    findings: ValidateFinding[];
    label: string;
    ok: boolean;
    rules: ValidateRuleState[];
}

Index

Properties

commit descriptors findings label ok rules

Properties

`Readonly`commit

commit: string | null

The commit read, when known.

`Readonly`descriptors

descriptors: number

How many descriptor files were read.

`Readonly`findings

findings: ValidateFinding[]

Every failure, by file then rule.

`Readonly`label

label: string

The index's short name.

`Readonly`ok

ok: boolean

True when no rule that ran failed a file.

`Readonly`rules

rules: ValidateRuleState[]

Each rule's state, in order.

Interface ValidateReport

Example

Index

Properties

Properties

`Readonly`commit

`Readonly`descriptors

`Readonly`findings

`Readonly`label

`Readonly`ok

`Readonly`rules

Settings

On This Page

Interface ValidateReport

Example

Index

Properties

Properties

Readonlycommit

Readonlydescriptors

Readonlyfindings

Readonlylabel

Readonlyok

Readonlyrules

Settings

On This Page

`Readonly`commit

`Readonly`descriptors

`Readonly`findings

`Readonly`label

`Readonly`ok

`Readonly`rules