CTRF

---

CTRF / ReportBuilder

Class: ReportBuilder

Defined in: builder.ts:49

Example

const report = new ReportBuilder()
  .specVersion('1.0.0')
  .tool({ name: 'jest', version: '29.0.0' })
  .environment({ branchName: 'main' })
  .addTest(
    new TestBuilder()
      .name('should add numbers')
      .status('passed')
      .duration(150)
      .build()
  )
  .build();

Constructors

Constructor

new ReportBuilder(options?): ReportBuilder

Defined in: builder.ts:62

Parameters

options?

ReportBuilderOptions = {}

Returns

ReportBuilder

Methods

specVersion()

specVersion(version): this

Defined in: builder.ts:74

Set the spec version.

Parameters

version

string

Returns

this

---

reportId()

reportId(uuid?): this

Defined in: builder.ts:83

Set or generate the report ID.

Parameters

uuid?

string

UUID to use, or undefined to auto-generate

Returns

this

---

timestamp()

timestamp(date?): this

Defined in: builder.ts:92

Set the timestamp.

Parameters

date?

string | Date

Date to use, or undefined for current time

Returns

this

---

generatedBy()

generatedBy(name): this

Defined in: builder.ts:106

Set the generator name.

Parameters

name

string

Returns

this

---

tool()

tool(tool): this

Defined in: builder.ts:114

Set the tool information.

Parameters

tool

Tool

Returns

this

---

environment()

environment(env): this

Defined in: builder.ts:122

Set the environment information.

Parameters

env

Environment

Returns

this

---

addTest()

addTest(test): this

Defined in: builder.ts:130

Add a single test.

Parameters

test

Test

Returns

this

---

addTests()

addTests(tests): this

Defined in: builder.ts:138

Add multiple tests.

Parameters

tests

Test[]

Returns

this

---

insights()

insights(insights): this

Defined in: builder.ts:146

Set run-level insights.

Parameters

insights

Insights

Returns

this

---

baseline()

baseline(baseline): this

Defined in: builder.ts:154

Set the baseline reference.

Parameters

baseline

Baseline

Returns

this

---

extra()

extra(data): this

Defined in: builder.ts:162

Set extra metadata.

Parameters

data

Record<string, unknown>

Returns

this

---

summaryOverrides()

summaryOverrides(overrides): this

Defined in: builder.ts:171

Override specific summary fields. Useful when you want to set specific timing or counts.

Parameters

overrides

Partial<Summary>

Returns

this

---

build()

build(): CTRFReport

Defined in: builder.ts:180

Build and return the CTRF report.

Returns

CTRFReport

Throws

BuilderError if required fields are missing