@locustjs/test 2.0.0 → 2.0.2

package/README.md

@@ -8,7 +8,7 @@ npm i @locustjs/test
 
 ## Current Version
 ```
-2.0.0
+2.0.2
 ```
 
 # Usage
@@ -16,9 +16,9 @@ npm i @locustjs/test
 import { TestRunner } from '@locustjs/test';
 
 const tests = [
-  ['test 1', expect => expect(2 + 2).toBe(4)],
-  ['test 2', expect => expect(undefined).toBeUndefined()],
-  ['test 3', expect => expect(5).toBeGt(10)],  // this test fails
+  ['test 1', () => expect(2 + 2).toBe(4)],
+  ['test 2', () => expect(undefined).toBeUndefined()],
+  ['test 3', () => expect(5).toBeGt(10)],  // this test fails
   ...
 ];
 
@@ -48,7 +48,7 @@ Sample output:
 <div style="color:gray; margin-left: 50px">error 501: test 'Test 7: error' failed.</div>
 <div style="color:yellow; margin-left: 50px">10 is not greater than 20</div>
 
-8. <b>Test 8: not expected:</b> <span style="color:magenta">expect not used</span> (0 sec)
+8. <b>Test 8: not satisfied:</b> <span style="color:magenta">expect not used</span> (0 sec)
 
 9. <b>Test 9: error without expect:</b> <span style="color:yellow">faulted</span> (0 sec)
 <div style="color:gray; margin-left: 50px">error 501: test 'Test 9: error without expect' failed.</div>
@@ -71,6 +71,19 @@ Sample output:
 
 Pay attention: `TestRunner` runs test simultaneously. Thus, tests should not have side-effects.
 
+## Various examples:
+```javascript
+import { Test, TestRunner } from '@locustjs/test';
+
+const t1 = new Test('test 1', () => expect(2 + 2).toBe(4));
+const t2 = () => expect(2 + 2).toBe(4);
+const t3 = [t1]
+const t4 = [t1, t2]
+const t5 = ['test 5', () => expect(2 + 2).toBe(4)]
+
+TestRunner.start(t1, t2, t3, t4, t5)
+```
+
 ## expect
 Positive
 - `toBe(value)`
@@ -152,7 +165,7 @@ Negative
 - `async notToThrowAsync(ex, shape = false, strict = false)`
 - `notToBeNaN()`
 
-## Qucik Testing
+## Quick Testing
 
 `TestRunner` has a static method `start()` that simplifies running tests.
 
@@ -174,13 +187,13 @@ import tests3 from './test3.js'
 TestRunner.start(tests1, tests2, tests3);
 ```
 
-The above example is equal to merging all tests arrays and pass one array to `start()`.
+The above example is equal to merging all tests and pass one array to `start()`.
 
 ```javascript
 TestRunner.start([...tests1, ...tests2, ...tests3])
 ```
 
-By default, test runner shows detailed output only when there is at least one error. However, by passing `true` as the last argument of `start()` method, we can ask the detailed output is always shows.
+By default, test runner shows detailed output only when there is at least one error. However, by passing `true` as the last argument of `start()` method, we can ask the detailed output to be always shown.
 
 ```javascript
 TestRunner.start(tests, true);