Logo Xantham

FindingCatalogue Module

Functions and values

Function or value Description

passLabel pass

Full Usage: passLabel pass

Parameters:
    pass : string

Returns: string

How the manifest labels a pass: its prefix and name, `SI - shape-interfaces`, or the bare name for a pass that owns no union.

pass : string
Returns: string

passPrefixes

Full Usage: passPrefixes

Returns: Map<string, string>

Pass name -> the key prefix of the union that pass owns. Passes without a union never raise findings of their own and are absent.

Returns: Map<string, string>

table ()

Full Usage: table ()

Parameters:
    () : unit

Returns: (string * string * Tier) list

The whole key table: `(key, union case name, tier)` for every case of every union.

() : unit
Returns: (string * string * Tier) list

unions

Full Usage: unions

Returns: Type list

Every finding union, in the order the manifest legend lists them. The snapshot test enumerates these; a union missing here has keys nothing guards.

Returns: Type list

Type something to start searching.