clientnode 3.0.834 → 3.0.838

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 (8) hide show
  1. package/index.d.ts +201 -213
  2. package/index.js +1 -1
  3. package/package.json +1 -1
  4. package/property-types.d.ts +12 -1
  5. package/property-types.js +1 -1
  6. package/testHelper.d.ts +17 -19
  7. package/testHelper.js +1 -1
  8. package/type.d.ts +44 -42
package/testHelper.d.ts CHANGED
@@ -5,10 +5,11 @@ export declare const ThrowSymbol: unique symbol;
5
5
  export declare const UndefinedSymbol: unique symbol;
6
6
  /**
7
7
  * Tests given result against given expectations. Respects special symbol
8
- * values
8
+ * values.
9
9
  * @param givenResult - Target to compare expectation against.
10
10
  * @param expected - Expected result.
11
11
  * @param wrap - Indicates whether to wrap with an expect function call.
12
+ *
12
13
  * @returns Nothing.
13
14
  */
14
15
  export declare const testExpectedType: <Type = unknown>(givenResult: Type | jest.JestMatchers<Type>, expected: Type | TestSymbol, wrap?: boolean) => Promise<void> | void;
@@ -16,11 +17,11 @@ export declare const testExpectedType: <Type = unknown>(givenResult: Type | jest
16
17
  * Tests each given test set (expected value follows by various list of
17
18
  * function parameters). It respects function signature to raise compile time
18
19
  * errors if given test set does not match given function signature.
19
- *
20
20
  * @param functionName - Function description to test.
21
21
  * @param callback - Function reference to test.
22
22
  * @param functionTestTuple - Additional arrays of test sets to test given
23
23
  * function again.
24
+ *
24
25
  * @returns Nothing.
25
26
  */
26
27
  export declare const testEach: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: [ReturnType<FunctionType>, ...Parameters<FunctionType>][]) => void;
@@ -28,11 +29,11 @@ export declare const testEach: <FunctionType extends AnyFunction = GenericFuncti
28
29
  * Tests each given test set (expected value follows by various list of
29
30
  * function parameters). It respects function signature to raise compile time
30
31
  * errors if given test set does not match given function signature.
31
- *
32
32
  * @param functionName - Function description to test.
33
33
  * @param callback - Function reference to test.
34
34
  * @param functionTestTuple - Additional arrays of test sets to test given
35
35
  * function again.
36
+ *
36
37
  * @returns Nothing.
37
38
  */
38
39
  export declare const testEachPromise: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: [ThenParameter<ReturnType<FunctionType>>, ...Parameters<FunctionType>][]) => void;
@@ -40,11 +41,11 @@ export declare const testEachPromise: <FunctionType extends AnyFunction = Generi
40
41
  * Tests each given test set (expected value follows by various list of
41
42
  * function parameters). It respects function signature to raise compile time
42
43
  * errors if given test set does not match given function signature.
43
- *
44
44
  * @param functionName - Function description to test.
45
45
  * @param callback - Function reference to test.
46
46
  * @param functionTestTuple - Additional arrays of test sets to test given
47
47
  * function again.
48
+ *
48
49
  * @returns Nothing.
49
50
  */
50
51
  export declare const testEachPromiseRejection: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: [Error, ...Parameters<FunctionType>][]) => void;
@@ -52,12 +53,11 @@ export declare const testEachPromiseRejection: <FunctionType extends AnyFunction
52
53
  * Tests each given single parameter against same given expected value. It
53
54
  * respects function signature to raise compile time errors if given test set
54
55
  * does not match given function signature.
55
- *
56
56
  * @param functionName - Function description to test.
57
57
  * @param callback - Function reference to test.
58
58
  * @param expected - Value to check each function call return value against.
59
- * @param functionTestTuple - Additional arrays of parameter to test given
60
- * function with.
59
+ * @param parameters - Additional first parameters to test given function with.
60
+ *
61
61
  * @returns Nothing.
62
62
  */
63
63
  export declare const testEachSingleParameterAgainstSameExpectation: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ReturnType<FunctionType>, ...parameters: FirstParameter<FunctionType>[]) => void;
@@ -65,12 +65,11 @@ export declare const testEachSingleParameterAgainstSameExpectation: <FunctionTyp
65
65
  * Tests each given single parameter against same given expected value. It
66
66
  * respects function signature to raise compile time errors if given test set
67
67
  * does not match given function signature.
68
- *
69
68
  * @param functionName - Function description to test.
70
69
  * @param callback - Function reference to test.
71
70
  * @param expected - Value to check each function call return value against.
72
- * @param functionTestTuple - Additional arrays of parameter to test given
73
- * function with.
71
+ * @param parameters - Additional first parameters to test given function with.
72
+ *
74
73
  * @returns Nothing.
75
74
  */
76
75
  export declare const testEachSingleParameterAgainstSamePromisedExpectation: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...parameters: FirstParameter<FunctionType>[]) => void;
@@ -78,12 +77,11 @@ export declare const testEachSingleParameterAgainstSamePromisedExpectation: <Fun
78
77
  * Tests each given single parameter against same given expected value. It
79
78
  * respects function signature to raise compile time errors if given test set
80
79
  * does not match given function signature.
81
- *
82
80
  * @param functionName - Function description to test.
83
81
  * @param callback - Function reference to test.
84
82
  * @param expected - Value to check each function call return value against.
85
- * @param functionTestTuple - Additional arrays of parameter to test given
86
- * function with.
83
+ * @param parameters - Additional first parameters to test given function with.
84
+ *
87
85
  * @returns Nothing.
88
86
  */
89
87
  export declare const testEachSingleParameterAgainstSameRejectedExpectation: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...parameters: FirstParameter<FunctionType>[]) => void;
@@ -91,12 +89,12 @@ export declare const testEachSingleParameterAgainstSameRejectedExpectation: <Fun
91
89
  * Tests each given test set (various list of function parameters) against same
92
90
  * given expected value. It respects function signature to raise compile time
93
91
  * errors if given test set does not match given function signature.
94
- *
95
92
  * @param functionName - Function description to test.
96
93
  * @param callback - Function reference to test.
97
94
  * @param expected - Value to check each function call return value against.
98
- * @param functionTestTuple - Additional arrays of parameters to test given
95
+ * @param functionParameters - Additional lists of parameters to test given
99
96
  * function again.
97
+ *
100
98
  * @returns Nothing.
101
99
  */
102
100
  export declare const testEachAgainstSameExpectation: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ReturnType<FunctionType>, ...functionParameters: Parameters<FunctionType>[]) => void;
@@ -104,12 +102,12 @@ export declare const testEachAgainstSameExpectation: <FunctionType extends AnyFu
104
102
  * Tests each given test set (various list of function parameters) against same
105
103
  * given expected value. It respects function signature to raise compile time
106
104
  * errors if given test set does not match given function signature.
107
- *
108
105
  * @param functionName - Function description to test.
109
106
  * @param callback - Function reference to test.
110
107
  * @param expected - Value to check each function call return value against.
111
- * @param functionTestTuple - Additional arrays of parameters to test given
108
+ * @param functionParameters - Additional lists of parameters to test given
112
109
  * function again.
110
+ *
113
111
  * @returns Nothing.
114
112
  */
115
113
  export declare const testEachPromiseAgainstSameExpectation: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...functionParameters: Parameters<FunctionType>[]) => void;
@@ -117,12 +115,12 @@ export declare const testEachPromiseAgainstSameExpectation: <FunctionType extend
117
115
  * Tests each given test set (various list of function parameters) against same
118
116
  * given expected value. It respects function signature to raise compile time
119
117
  * errors if given test set does not match given function signature.
120
- *
121
118
  * @param functionName - Function description to test.
122
119
  * @param callback - Function reference to test.
123
120
  * @param expected - Value to check each function call return value against.
124
- * @param functionTestTuple - Additional arrays of parameters to test given
121
+ * @param functionParameters - Additional lists of parameters to test given
125
122
  * function again.
123
+ *
126
124
  * @returns Nothing.
127
125
  */
128
126
  export declare const testEachPromiseRejectionAgainstSameExpectation: <FunctionType extends AnyFunction = GenericFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...functionParameters: Parameters<FunctionType>[]) => void;