Skip to content

Commit a11ad86

Browse files
committed
chore: remove unused properties from Summary and Test interfaces for clarity
1 parent 3f53c96 commit a11ad86

File tree

14 files changed

+100
-552
lines changed

14 files changed

+100
-552
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ final
33
scripts
44
coverage
55
dist
6-
node_modules
6+
node_modules
7+
ctrf

ctrf/ctrf-report.json

Lines changed: 0 additions & 393 deletions
This file was deleted.

docs/interfaces/Attachment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,36 @@
66

77
# Interface: Attachment
88

9-
Defined in: [types/ctrf.d.ts:112](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L112)
9+
Defined in: [types/ctrf.d.ts:100](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L100)
1010

1111
## Properties
1212

1313
### contentType
1414

1515
> **contentType**: `string`
1616
17-
Defined in: [types/ctrf.d.ts:114](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L114)
17+
Defined in: [types/ctrf.d.ts:102](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L102)
1818

1919
***
2020

2121
### extra?
2222

2323
> `optional` **extra**: `Record`\<`string`, `unknown`\>
2424
25-
Defined in: [types/ctrf.d.ts:116](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L116)
25+
Defined in: [types/ctrf.d.ts:104](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L104)
2626

2727
***
2828

2929
### name
3030

3131
> **name**: `string`
3232
33-
Defined in: [types/ctrf.d.ts:113](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L113)
33+
Defined in: [types/ctrf.d.ts:101](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L101)
3434

3535
***
3636

3737
### path
3838

3939
> **path**: `string`
4040
41-
Defined in: [types/ctrf.d.ts:115](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L115)
41+
Defined in: [types/ctrf.d.ts:103](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L103)

docs/interfaces/Environment.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,132 +6,132 @@
66

77
# Interface: Environment
88

9-
Defined in: [types/ctrf.d.ts:81](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L81)
9+
Defined in: [types/ctrf.d.ts:69](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L69)
1010

1111
## Properties
1212

1313
### appName?
1414

1515
> `optional` **appName**: `string`
1616
17-
Defined in: [types/ctrf.d.ts:83](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L83)
17+
Defined in: [types/ctrf.d.ts:71](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L71)
1818

1919
***
2020

2121
### appVersion?
2222

2323
> `optional` **appVersion**: `string`
2424
25-
Defined in: [types/ctrf.d.ts:84](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L84)
25+
Defined in: [types/ctrf.d.ts:72](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L72)
2626

2727
***
2828

2929
### branchName?
3030

3131
> `optional` **branchName**: `string`
3232
33-
Defined in: [types/ctrf.d.ts:92](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L92)
33+
Defined in: [types/ctrf.d.ts:80](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L80)
3434

3535
***
3636

3737
### buildId?
3838

3939
> `optional` **buildId**: `string`
4040
41-
Defined in: [types/ctrf.d.ts:85](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L85)
41+
Defined in: [types/ctrf.d.ts:73](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L73)
4242

4343
***
4444

4545
### buildName?
4646

4747
> `optional` **buildName**: `string`
4848
49-
Defined in: [types/ctrf.d.ts:86](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L86)
49+
Defined in: [types/ctrf.d.ts:74](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L74)
5050

5151
***
5252

5353
### buildNumber?
5454

5555
> `optional` **buildNumber**: `number`
5656
57-
Defined in: [types/ctrf.d.ts:87](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L87)
57+
Defined in: [types/ctrf.d.ts:75](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L75)
5858

5959
***
6060

6161
### buildUrl?
6262

6363
> `optional` **buildUrl**: `string`
6464
65-
Defined in: [types/ctrf.d.ts:88](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L88)
65+
Defined in: [types/ctrf.d.ts:76](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L76)
6666

6767
***
6868

6969
### commit?
7070

7171
> `optional` **commit**: `string`
7272
73-
Defined in: [types/ctrf.d.ts:91](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L91)
73+
Defined in: [types/ctrf.d.ts:79](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L79)
7474

7575
***
7676

7777
### extra?
7878

7979
> `optional` **extra**: `Record`\<`string`, `unknown`\>
8080
81-
Defined in: [types/ctrf.d.ts:97](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L97)
81+
Defined in: [types/ctrf.d.ts:85](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L85)
8282

8383
***
8484

8585
### osPlatform?
8686

8787
> `optional` **osPlatform**: `string`
8888
89-
Defined in: [types/ctrf.d.ts:93](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L93)
89+
Defined in: [types/ctrf.d.ts:81](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L81)
9090

9191
***
9292

9393
### osRelease?
9494

9595
> `optional` **osRelease**: `string`
9696
97-
Defined in: [types/ctrf.d.ts:94](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L94)
97+
Defined in: [types/ctrf.d.ts:82](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L82)
9898

9999
***
100100

101101
### osVersion?
102102

103103
> `optional` **osVersion**: `string`
104104
105-
Defined in: [types/ctrf.d.ts:95](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L95)
105+
Defined in: [types/ctrf.d.ts:83](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L83)
106106

107107
***
108108

109109
### reportName?
110110

111111
> `optional` **reportName**: `string`
112112
113-
Defined in: [types/ctrf.d.ts:82](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L82)
113+
Defined in: [types/ctrf.d.ts:70](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L70)
114114

115115
***
116116

117117
### repositoryName?
118118

119119
> `optional` **repositoryName**: `string`
120120
121-
Defined in: [types/ctrf.d.ts:89](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L89)
121+
Defined in: [types/ctrf.d.ts:77](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L77)
122122

123123
***
124124

125125
### repositoryUrl?
126126

127127
> `optional` **repositoryUrl**: `string`
128128
129-
Defined in: [types/ctrf.d.ts:90](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L90)
129+
Defined in: [types/ctrf.d.ts:78](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L78)
130130

131131
***
132132

133133
### testEnvironment?
134134

135135
> `optional` **testEnvironment**: `string`
136136
137-
Defined in: [types/ctrf.d.ts:96](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L96)
137+
Defined in: [types/ctrf.d.ts:84](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L84)

docs/interfaces/Insights.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,68 +6,68 @@
66

77
# Interface: Insights
88

9-
Defined in: [types/ctrf.d.ts:135](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L135)
9+
Defined in: [types/ctrf.d.ts:123](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L123)
1010

1111
## Properties
1212

1313
### averageRunDuration?
1414

1515
> `optional` **averageRunDuration**: [`InsightsMetric`](InsightsMetric.md)
1616
17-
Defined in: [types/ctrf.d.ts:140](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L140)
17+
Defined in: [types/ctrf.d.ts:128](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L128)
1818

1919
***
2020

2121
### averageTestDuration?
2222

2323
> `optional` **averageTestDuration**: [`InsightsMetric`](InsightsMetric.md)
2424
25-
Defined in: [types/ctrf.d.ts:142](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L142)
25+
Defined in: [types/ctrf.d.ts:130](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L130)
2626

2727
***
2828

2929
### extra?
3030

3131
> `optional` **extra**: `Record`\<`string`, `unknown`\>
3232
33-
Defined in: [types/ctrf.d.ts:143](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L143)
33+
Defined in: [types/ctrf.d.ts:131](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L131)
3434

3535
***
3636

3737
### failRate?
3838

3939
> `optional` **failRate**: [`InsightsMetric`](InsightsMetric.md)
4040
41-
Defined in: [types/ctrf.d.ts:138](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L138)
41+
Defined in: [types/ctrf.d.ts:126](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L126)
4242

4343
***
4444

4545
### flakyRate?
4646

4747
> `optional` **flakyRate**: [`InsightsMetric`](InsightsMetric.md)
4848
49-
Defined in: [types/ctrf.d.ts:139](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L139)
49+
Defined in: [types/ctrf.d.ts:127](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L127)
5050

5151
***
5252

5353
### p95RunDuration?
5454

5555
> `optional` **p95RunDuration**: [`InsightsMetric`](InsightsMetric.md)
5656
57-
Defined in: [types/ctrf.d.ts:141](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L141)
57+
Defined in: [types/ctrf.d.ts:129](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L129)
5858

5959
***
6060

6161
### passRate?
6262

6363
> `optional` **passRate**: [`InsightsMetric`](InsightsMetric.md)
6464
65-
Defined in: [types/ctrf.d.ts:137](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L137)
65+
Defined in: [types/ctrf.d.ts:125](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L125)
6666

6767
***
6868

6969
### runsAnalyzed?
7070

7171
> `optional` **runsAnalyzed**: `number`
7272
73-
Defined in: [types/ctrf.d.ts:136](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L136)
73+
Defined in: [types/ctrf.d.ts:124](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L124)

docs/interfaces/InsightsMetric.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,28 @@
66

77
# Interface: InsightsMetric
88

9-
Defined in: [types/ctrf.d.ts:156](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L156)
9+
Defined in: [types/ctrf.d.ts:144](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L144)
1010

1111
## Properties
1212

1313
### baseline
1414

1515
> **baseline**: `number`
1616
17-
Defined in: [types/ctrf.d.ts:158](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L158)
17+
Defined in: [types/ctrf.d.ts:146](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L146)
1818

1919
***
2020

2121
### change
2222

2323
> **change**: `number`
2424
25-
Defined in: [types/ctrf.d.ts:159](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L159)
25+
Defined in: [types/ctrf.d.ts:147](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L147)
2626

2727
***
2828

2929
### current
3030

3131
> **current**: `number`
3232
33-
Defined in: [types/ctrf.d.ts:157](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L157)
33+
Defined in: [types/ctrf.d.ts:145](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L145)

0 commit comments

Comments
 (0)