Class default<CustomTags>

The reporter class being called by Jest when supplied as a argument to 'reporters' config option.

Type Parameters

CustomTags extends string = AllTagsName

Hierarchy

default

Implements

Pick<Reporter, "onRunComplete">

Index

Constructors

Properties

compilerOptions options rootDir

Methods

getRenderData getRenderOutput getTaggedResult onRunComplete

Constructors

constructor

new default<CustomTags>(globalConfig, options): default<CustomTags>
Type Parameters
- CustomTags extends string = AllTagsName
Parameters
- globalConfig: GlobalConfig
  
  Config options from Jest
- options: TsDocTestReporterConfig<CustomTags>
  
  Options passed from consumer
Returns default<CustomTags>
- Defined in packages/jest/src/lib/reporter/index.ts:39

Properties

`Private` `Readonly` compilerOptions

compilerOptions: CompilerOptions

`Private` `Readonly` options

options: TsDocTestReporterConfig<CustomTags>

`Private` rootDir

rootDir: string

Methods

`Private` getRenderData

getRenderData(result): UITestResult[]
Parameters
- result: TaggedAggregatedResult
Returns UITestResult[]
- Defined in packages/jest/src/lib/reporter/index.ts:71

`Private` getRenderOutput

getRenderOutput(results): string
Parameters
- results: AggregatedResult
Returns string
- Defined in packages/jest/src/lib/reporter/index.ts:78

getTaggedResult

getTaggedResult(results): TaggedAggregatedResult
Attached tags to test results
Parameters
- results: AggregatedResult
  
  Test result without attached tags
Returns TaggedAggregatedResult
Test Results with attached tags
- Defined in packages/jest/src/lib/reporter/index.ts:53

onRunComplete

onRunComplete(_testContexts, results): void | Promise<void>
Runs when all tests are finished and outputs result to specified output file
Parameters
- _testContexts: Set<TestContext>
  
  Internals from Jest, not used for this reporter
- results: AggregatedResult
  
  Test Results
Returns void | Promise<void>
Implementation of Pick.onRunComplete
- Defined in packages/jest/src/lib/reporter/index.ts:95

Generated using TypeDoc