@xylabs/jest-helpers 4.13.20 → 4.13.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +130 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,13 +12,140 @@
12
12
  [![snyk-badge][]][snyk-link]
13
13
  [![socket-badge][]][socket-link]
14
14
 
15
- Version: 4.13.19
16
15
 
17
16
  Base functionality used throughout XY Labs TypeScript/JavaScript libraries
18
17
 
19
- ## Documentation
18
+ ## Reference
19
+
20
+ **@xylabs/jest-helpers**
21
+
22
+ ***
23
+
24
+ ## Functions
25
+
26
+ - [describeIf](#functions/describeIf)
27
+ - [itIf](#functions/itIf)
28
+ - [tags](#functions/tags)
29
+ - [testIf](#functions/testIf)
30
+
31
+ ### functions
32
+
33
+ ### <a id="describeIf"></a>describeIf
34
+
35
+ [**@xylabs/jest-helpers**](#../README)
36
+
37
+ ***
38
+
39
+ ```ts
40
+ function describeIf<T>(expr?): any;
41
+ ```
42
+
43
+ Conditionally runs or skips the describe
44
+
45
+ ## Type Parameters
46
+
47
+ ### T
48
+
49
+ `T`
50
+
51
+ ## Parameters
52
+
53
+ ### expr?
54
+
55
+ The condition to evaluate
56
+
57
+ `null` | `T`
58
+
59
+ ## Returns
60
+
61
+ `any`
62
+
63
+ If the condition is true, describe, otherwise skips
64
+
65
+ ### <a id="itIf"></a>itIf
66
+
67
+ [**@xylabs/jest-helpers**](#../README)
68
+
69
+ ***
70
+
71
+ ```ts
72
+ function itIf<T>(expr?): any;
73
+ ```
74
+
75
+ Conditionally runs or skips the it
76
+
77
+ ## Type Parameters
78
+
79
+ ### T
80
+
81
+ `T`
82
+
83
+ ## Parameters
84
+
85
+ ### expr?
86
+
87
+ The condition to evaluate
88
+
89
+ `null` | `T`
90
+
91
+ ## Returns
92
+
93
+ `any`
94
+
95
+ If the condition is true, it, otherwise skips
96
+
97
+ ### <a id="tags"></a>tags
98
+
99
+ [**@xylabs/jest-helpers**](#../README)
100
+
101
+ ***
102
+
103
+ ```ts
104
+ function tags(...tagLabels): Record<string, any>;
105
+ ```
106
+
107
+ ## Parameters
108
+
109
+ ### tagLabels
110
+
111
+ ...`string`[]
112
+
113
+ ## Returns
114
+
115
+ `Record`\<`string`, `any`\>
116
+
117
+ ### <a id="testIf"></a>testIf
118
+
119
+ [**@xylabs/jest-helpers**](#../README)
120
+
121
+ ***
122
+
123
+ ```ts
124
+ function testIf<T>(expr?): any;
125
+ ```
126
+
127
+ Conditionally runs or skips the test
128
+
129
+ ## Type Parameters
130
+
131
+ ### T
132
+
133
+ `T`
134
+
135
+ ## Parameters
136
+
137
+ ### expr?
138
+
139
+ The condition to evaluate
140
+
141
+ `null` | `T`
142
+
143
+ ## Returns
144
+
145
+ `any`
146
+
147
+ If the condition is true, test, otherwise skips
20
148
 
21
- Coming Soon!
22
149
 
23
150
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
24
151
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/jest-helpers",
3
- "version": "4.13.20",
3
+ "version": "4.13.22",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "jest",
@@ -43,7 +43,7 @@
43
43
  ],
44
44
  "devDependencies": {
45
45
  "@types/jest": "^30.0.0",
46
- "@types/node": "^24.0.14",
46
+ "@types/node": "^24.0.15",
47
47
  "@xylabs/ts-scripts-yarn3": "^7.0.0",
48
48
  "@xylabs/tsconfig": "^7.0.0",
49
49
  "typescript": "^5.8.3"