lib/coverage - jsdoc-scribe API

Functions(2)

#aggregateCoverage

Sum per-file coverage stats into a project-wide aggregate.

Parameter	Type	Optional	Description
`fileResults`	`{documented:number,total:number,undocumented:number}[]`

Returns: {documented:number,total:number,undocumented:number,pct:number}

Signature

aggregateCoverage(fileResults: any): any

#renderBadgeSvg

line 33

Render a static, deterministic, shields.io-visual-style SVG coverage badge.

Parameter	Type	Optional	Description
`pct`	`number`

Returns: string — shields.io-style SVG markup

Signature

renderBadgeSvg(pct: any): any

Variables & Constants(11)

#documented

line 18

let documented: number

var

Signature

let documented: number

#total

line 18

let total: number

var

Signature

let total: number

#undocumented

line 18

let undocumented: number

var

Signature

let undocumented: number

#pct

line 24

let pct: any

var

Signature

let pct: any

#color

line 34

let color: any

var

Signature

let color: any

#label

line 35

let label: string

var

Signature

let label: string

#value

line 36

let value: any

var

Signature

let value: any

#labelW

line 37

let labelW: number

var

Signature

let labelW: number

#valueW

line 37

let valueW: number

var

Signature

let valueW: number

line 37

let h: number

var

Signature

let h: number

#totalW

line 38

let totalW: any

var

Signature

let totalW: any