Class HTML

Initialize a new HTML reporter.

This reporter cannot be used on the console.

see: https://mochajs.org/api/Mocha.reporters.HTML.html

Hierarchy

Base
- HTML

Index

Modules

cursor

Interfaces

Constructors

constructor

Properties

Methods

Constructors

constructor

new HTML(runner: Runner, options?: MochaOptions): HTML
new HTML(runner: IRunner, options?: MochaOptions): HTML

Inherited from Base.constructor
- Defined in node_modules/@types/mocha/index.d.ts:685
Parameters
- runner: Runner
- Optional options: MochaOptions
Returns HTML
Inherited from Base.constructor
- Defined in node_modules/@types/mocha/index.d.ts:686
deprecated

Use the overload that accepts Mocha.Runner instead.

Parameters
- runner: IRunner
- Optional options: MochaOptions
Returns HTML

Properties

failures

failures: Test[]

Test failures

runner

runner: Runner

The configured runner

stats

stats: Stats

Test run statistics

Static colors

colors: ColorMap

Default color map

see: https://mochajs.org/api/module-base#.colors

Static inlineDiffs

inlineDiffs: boolean

Inline diffs instead of +/-

see: https://mochajs.org/api/module-base#.inlineDiffs

Static symbols

symbols: SymbolMap

Default symbol map

see: https://mochajs.org/api/module-base#.symbols

Static useColors

useColors: boolean

Enables coloring by default

see: https://mochajs.org/api/module-base#.useColors

Static window

window: object

Expose terminal window size

see: https://mochajs.org/api/module-base#.window

Type declaration

width: number

Methods

addCodeToggle

addCodeToggle(el: HTMLLIElement, contents: string): void

- Defined in node_modules/@types/mocha/index.d.ts:918
Adds code toggle functionality for the provided test's list element.

see

https://mochajs.org/api/Mocha.reporters.HTML.html#addCodeToggle

Parameters
- el: HTMLLIElement
- contents: string
Returns void

Optional done

done(failures: number, fn?: undefined | function): void

Inherited from Base.done
- Defined in node_modules/@types/mocha/index.d.ts:712
Parameters
- failures: number
- Optional fn: undefined | function
Returns void

epilogue

epilogue(): void

Inherited from Base.epilogue
- Defined in node_modules/@types/mocha/index.d.ts:710
Output common epilogue used by many of the bundled reporters.

see

https://mochajs.org/api/Mocha.reporters.Base.html#.Base#epilogue

Returns void

suiteURL

suiteURL(suite: Suite): string

- Defined in node_modules/@types/mocha/index.d.ts:904
Provide suite URL.

see

https://mochajs.org/api/Mocha.reporters.HTML.html#suiteURL

Parameters
- suite: Suite
Returns string

testURL

testURL(test: Test): string

- Defined in node_modules/@types/mocha/index.d.ts:911
Provide test URL.

see

https://mochajs.org/api/Mocha.reporters.HTML.html#testURL

Parameters
- test: Test
Returns string

Static color

color(type: string, str: string): string

- Defined in node_modules/@types/mocha/index.d.ts:801
Color str with the given type (from colors)

see

https://mochajs.org/api/module-base#.color

Parameters
- type: string
- str: string
Returns string

Static generateDiff

generateDiff(actual: string, expected: string): string

- Defined in node_modules/@types/mocha/index.d.ts:849
Returns a diff between two strings with colored ANSI output.

see

https://mochajs.org/api/module-base#.generateDiff

Parameters
- actual: string
- expected: string
Returns string

Static list

list(failures: Test[]): void

- Defined in node_modules/@types/mocha/index.d.ts:856
Output the given failures as a list.

see

https://mochajs.org/api/Mocha.reporters.Base.html#.exports.list1

Parameters
- failures: Test[]
Returns void

Generated using TypeDoc