Merge pull request #2 from WezomCompany/develop

Develop
WezomCompany · Mar 7, 2021 · 3ad70ce · 3ad70ce
2 parents 846392a + 18c4242
commit 3ad70ce
Show file tree

Hide file tree

Showing 6 changed files with 624 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,6 @@
 
 ---
 
-
 ## Usage
 
 ### Install npm package
@@ -45,35 +44,37 @@ Function signature test with set of custom cases
 
 _Parameters:_
 
-| Name   | Data type | Argument | Default value | Description |
-| ------ | --------- | -------- | ------------- | ----------- |
-| method | `T`       |          |               |
-| cases  |           |          |               |
+| Name   | Data type                                                                 | Argument | Default value | Description |
+| ------ | ------------------------------------------------------------------------- | -------- | ------------- | ----------- |
+| method | `T`                                                                       |          |               |
+| cases  | `{ name?: string; parameters: Parameters<T>; expected: ReturnType<T> }[]` |          |               |
 
 _Returns:_ `void`
 
 _Examples:_
 
 ```ts
-// x.ts
-export const x = (y: boolean, z: number, w: number): number | null => (y ? z + w : null);
-
-// x.spec.ts
-import x from 'x.ts';
-import { jestFunctionSignatureTest } from '@wezom/toolkit-jest';
-
-describe('Function signature should match specification', () => {
-	jestFunctionSignatureTest(x, [
-		{
-			parameters: [true, 4, 5],
-			expected: 9
-		},
-		{
-			parameters: [false, 4, 5],
-			expected: null
-		}
-	]);
-});
+ // x.ts
+ export const x = (y: boolean, z: number, w: number):number|null => y ? z + w : null;
+
+ // x.spec.ts
+ import x from 'x.ts'
+ import { jestFunctionSignatureTest } from '@wezom/toolkit-jest'
+
+ describe('Function signature should match specification', () => {
+     jestFunctionSignatureTest(x, [
+         {
+             parameters: [true, 4, 5],
+             expected: 9
+         },
+         {
+             name: 'Custom test name'
+             parameters: [false, 4, 5],
+             expected: null
+         }
+     ]);
+ });
+
 ```
 
 [comment]: <> (AUTODOC-TOOL-END)