Skip to content

Commit 5caa33b

Browse files
docs(TestingTests): update jsdoc
1 parent 805e2fa commit 5caa33b

1 file changed

Lines changed: 24 additions & 24 deletions

File tree

src/lib/testing-tests.class.ts

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export class TestingTests extends TestingCore {
5555
* @param value Any kind of value to check.
5656
* @param execute Whether or not to execute the spec, by default it's set to `true`.
5757
* @param expectation The message for the karma, which by default is set to `The value must be a bigint type`.
58-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
58+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
5959
* @returns The return value is an instance of a `TestingTests`.
6060
*/
6161
public toBeBigInt<Value>(
@@ -74,7 +74,7 @@ export class TestingTests extends TestingCore {
7474
* @param value Any kind of value to check.
7575
* @param execute Whether or not to execute the spec, by default it's set to `true`.
7676
* @param expectation The message for the karma, which by default is set to `The value must be of a boolean type`.
77-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
77+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
7878
* @returns The return value is an instance of a `TestingTests`.
7979
*/
8080
public toBeBooleanType<Value>(
@@ -93,7 +93,7 @@ export class TestingTests extends TestingCore {
9393
* @param value Any kind of value to check.
9494
* @param execute Whether or not to execute the spec, by default it's set to `true`.
9595
* @param expectation The message for the karma, which by default is set to `The value must be a class`.
96-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
96+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
9797
* @returns The return value is an instance of a `TestingTests`.
9898
*/
9999
public toBeClass<Value>(
@@ -115,7 +115,7 @@ export class TestingTests extends TestingCore {
115115
* @param execute Whether or not to execute the spec, by default it's set to `true`.
116116
* @param expectation The message for the karma, which by default is set to
117117
* `The value must be an instance of an Array`.
118-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
118+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
119119
* @returns The return value is an instance of a `TestingTests`.
120120
*/
121121
public toBeInstanceOfArray<Value>(
@@ -135,7 +135,7 @@ export class TestingTests extends TestingCore {
135135
* @param execute Whether or not to execute the spec, by default it's set to `true`.
136136
* @param expectation The message for the karma, which by default is set to
137137
* `The value must be an instance of Boolean`.
138-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
138+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
139139
* @returns The return value is an instance of a `TestingTests`.
140140
*/
141141
public toBeInstanceOfBoolean<Value>(
@@ -155,7 +155,7 @@ export class TestingTests extends TestingCore {
155155
* @param execute Whether or not to execute the spec, by default it's set to `true`.
156156
* @param expectation The message for the karma, which by default is set to
157157
* `The value must be an instance of Date`.
158-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
158+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
159159
* @returns The return value is an instance of a `TestingTests`.
160160
*/
161161
public toBeInstanceOfDate<Value>(
@@ -175,7 +175,7 @@ export class TestingTests extends TestingCore {
175175
* @param execute Whether or not to execute the spec, by default it's set to `true`.
176176
* @param expectation The message for the karma, which by default is set to
177177
* `The value must be an instance of an Error`.
178-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
178+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
179179
* @returns The return value is an instance of a `TestingTests`.
180180
*/
181181
public toBeInstanceOfError<Value>(
@@ -195,7 +195,7 @@ export class TestingTests extends TestingCore {
195195
* @param execute Whether or not to execute the spec, by default it's set to `true`.
196196
* @param expectation The message for the karma, which by default is set to
197197
* `The value must be an instance of a Function`.
198-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
198+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
199199
* @returns The return value is an instance of a `TestingTests`.
200200
*/
201201
public toBeInstanceOfFunction<Value>(
@@ -215,7 +215,7 @@ export class TestingTests extends TestingCore {
215215
* @param execute Whether or not to execute the spec, by default it's set to `true`.
216216
* @param expectation The message for the karma, which by default is set to
217217
* `The value must be an instance of a Map.
218-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
218+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
219219
* @returns The return value is an instance of a `TestingTests`.
220220
*/
221221
public toBeInstanceOfMap<Value>(
@@ -235,7 +235,7 @@ export class TestingTests extends TestingCore {
235235
* @param execute Whether or not to execute the spec, by default it's set to `true`.
236236
* @param expectation The message for the karma, which by default is set to
237237
* `The value must be an instance of a Number.
238-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
238+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
239239
* @returns The return value is an instance of a `TestingTests`.
240240
*/
241241
public toBeInstanceOfNumber<Value>(
@@ -255,7 +255,7 @@ export class TestingTests extends TestingCore {
255255
* @param execute Whether or not to execute the spec, by default it's set to `true`.
256256
* @param expectation The message for the karma, which by default is set to
257257
* `The value must be an instance of an Object.
258-
* @param toBe Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
258+
* @param toBe Expects the result of the expectation must be `true` or `false`, by default it's `true`.
259259
* @returns The return value is an instance of a `TestingTests`.
260260
*/
261261
public toBeInstanceOfObject<Value>(
@@ -275,7 +275,7 @@ export class TestingTests extends TestingCore {
275275
* @param execute Whether or not to execute the spec, by default it's set to `true`.
276276
* @param expectation The message for the karma, which by default is set to
277277
* `The value must be an instance of Promise`.
278-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
278+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
279279
* @returns The return value is an instance of a `TestingTests`.
280280
*/
281281
public toBeInstanceOfPromise<Value>(
@@ -296,7 +296,7 @@ export class TestingTests extends TestingCore {
296296
* @param execute Whether or not to execute the spec.
297297
* @param expectation The message for the karma, which by default is set to
298298
* `The value must be an instance of RangeError.
299-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
299+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
300300
* @returns The return value is an instance of a `TestingTests`.
301301
*/
302302
public toBeInstanceOfRangeError<Value>(
@@ -316,7 +316,7 @@ export class TestingTests extends TestingCore {
316316
* @param execute Whether or not to execute the spec, by default it's set to `true`.
317317
* @param expectation The message for the karma, which by default is set to
318318
* `The value must be an instance of ReferenceError.
319-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
319+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
320320
* @returns The return value is an instance of a `TestingTests`.
321321
*/
322322
public toBeInstanceOfReferenceError<Value>(
@@ -336,7 +336,7 @@ export class TestingTests extends TestingCore {
336336
* @param execute Whether or not to execute the spec, by default it's set to `true`.
337337
* @param expectation The message for the karma, which by default is set to
338338
* `The value must be an instance of RegExp.
339-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
339+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
340340
* @returns The return value is an instance of a `TestingTests`.
341341
*/
342342
public toBeInstanceOfRegExp<Value>(
@@ -356,7 +356,7 @@ export class TestingTests extends TestingCore {
356356
* @param execute Whether or not to execute the spec, by default it's set to `true`.
357357
* @param expectation The message for the karma, which by default is set to
358358
* `The value must be an instance of Set.
359-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
359+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
360360
* @returns The return value is an instance of a `TestingTests`.
361361
*/
362362
public toBeInstanceOfSet<Value>(
@@ -376,7 +376,7 @@ export class TestingTests extends TestingCore {
376376
* @param execute Whether or not to execute the spec, by default it's set to `true`.
377377
* @param expectation The message for the karma, which by default is set to
378378
* `The value must be an instance of Storage.
379-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
379+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
380380
* @returns The return value is an instance of a `TestingTests`.
381381
*/
382382
public toBeInstanceOfStorage<Value>(
@@ -395,7 +395,7 @@ export class TestingTests extends TestingCore {
395395
* @param value Any kind of value to check.
396396
* @param expectation The message for the karma, which by default is set to
397397
* `The value must be an instance of a String.
398-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
398+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
399399
* @param execute Whether or not to execute the spec.
400400
* @returns The return value is an instance of a `TestingTests`.
401401
*/
@@ -417,7 +417,7 @@ export class TestingTests extends TestingCore {
417417
* @param execute Whether or not to execute the spec, by default it's set to `true`.
418418
* @param expectation The message for the karma, which by default is set to
419419
* `The value must be an instance of SyntaxError.
420-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
420+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
421421
* @returns The return value is an instance of a `TestingTests`.
422422
*/
423423
public toBeInstanceOfSyntaxError<Value>(
@@ -437,7 +437,7 @@ export class TestingTests extends TestingCore {
437437
* @param execute Whether or not to execute the spec, by default it's set to `true`.
438438
* @param expectation The message for the karma, which by default is set to
439439
* `The value must be an instance of TypeError.
440-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
440+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
441441
* @returns The return value is an instance of a `TestingTests`.
442442
*/
443443
public toBeInstanceOfTypeError<Value>(
@@ -457,7 +457,7 @@ export class TestingTests extends TestingCore {
457457
* @param execute Whether or not to execute the spec, by default it's set to `true`.
458458
* @param expectation The message for the karma, which by default is set to
459459
* `The value must be an instance of URIError.
460-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
460+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
461461
* @returns The return value is an instance of a `TestingTests`.
462462
*/
463463
public toBeInstanceOfURIError<Value>(
@@ -477,7 +477,7 @@ export class TestingTests extends TestingCore {
477477
* @param execute Whether or not to execute the spec, by default it's set to `true`.
478478
* @param expectation The message for the karma, which by default is set to
479479
* `The value must be an instance of a WeakSet.
480-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
480+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
481481
* @returns The return value is an instance of a `TestingTests`.
482482
*/
483483
public toBeInstanceOfWeakSet<Value>(
@@ -496,7 +496,7 @@ export class TestingTests extends TestingCore {
496496
* @param value Any kind of value to check.
497497
* @param execute Whether or not to execute the spec, by default it's set to `true`.
498498
* @param expectation The message for the karma, which by default is set to `The value must be \`null\``.
499-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
499+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
500500
* @returns The return value is an instance of a `TestingTests`.
501501
*/
502502
public toBeNull<Value>(
@@ -515,7 +515,7 @@ export class TestingTests extends TestingCore {
515515
* @param value Any kind of value to check.
516516
* @param execute Whether or not to execute the spec, by default it's set to `true`.
517517
* @param expectation The message for the karma, which by default is set to `The value must be of a \`number\` type`.
518-
* @param expected Expects the result of the expectation must be of a `true` or `false` state, by default it's `true`.
518+
* @param expected Expects the result of the expectation must be `true` or `false`, by default it's `true`.
519519
* @returns The return value is an instance of a `TestingTests`.
520520
*/
521521
public toBeNumberType<Value>(

0 commit comments

Comments
 (0)