clientnode 4.0.1477 → 4.0.1479

package/dist/test-helper.d.ts

@@ -1,4 +1,4 @@
-import type { AnyFunction, FirstParameter, FunctionTestTuple, FunctionTestPromiseTuple, FunctionTestPromiseRejectionTuple, TestMatchers as Matchers, TestSymbol, ThenParameter, UnknownFunction } from './type';
+import { AnyFunction, FirstParameter, FunctionTestTuple, FunctionTestPromiseTuple, FunctionTestPromiseRejectionTuple, TestMatchers as Matchers, TestSymbol, ThenParameter, UnknownFunction, FunctionTestAgainstResolvedPromiseTuple, FunctionTestPromiseAgainstResolvedPromiseTuple, FunctionTestPromiseRejectionAgainstResolvedPromiseTuple } from './type';
 export declare const TEST_DEFINED_SYMBOL: unique symbol;
 export declare const TEST_THROW_SYMBOL: unique symbol;
 export declare const TEST_UNDEFINED_SYMBOL: unique symbol;
@@ -25,6 +25,21 @@ export declare const testEach: {
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestTuple<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestTuple<FunctionType>>): void;
 };
+/**
+ * Tests each given test set (promise resolving to expected value follows by
+ * various list of function parameters). It respects function signature to
+ * raise compile time errors if given test set does not match given function
+ * signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param functionTestTuple - Additional arrays of test sets to test given
+ * function again.
+ */
+export declare const testEachAgainstResolvedPromise: {
+    <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestAgainstResolvedPromiseTuple<FunctionType>>): void;
+    only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestAgainstResolvedPromiseTuple<FunctionType>>): void;
+    skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestAgainstResolvedPromiseTuple<FunctionType>>): void;
+};
 /**
  * Tests each given test set (expected value follows by various list of
  * function parameters). It respects function signature to raise compile time
@@ -34,7 +49,7 @@ export declare const testEach: {
  * @param functionTestTuple - Additional arrays of test sets to test given
  * function again.
  */
-export declare const testEachPromise: {
+export declare const testEachResolvedPromise: {
     <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseTuple<FunctionType>>): void;
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseTuple<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseTuple<FunctionType>>): void;
@@ -48,11 +63,35 @@ export declare const testEachPromise: {
  * @param functionTestTuple - Additional arrays of test sets to test given
  * function again.
  */
-export declare const testEachPromiseRejection: {
+export declare const testEachResolvedPromiseAgainstResolvedPromise: <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseAgainstResolvedPromiseTuple<FunctionType>>) => void;
+/**
+ * Tests each given test set (expected value follows by various list of
+ * function parameters). It respects function signature to raise compile time
+ * errors if given test set does not match given function signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param functionTestTuple - Additional arrays of test sets to test given
+ * function again.
+ */
+export declare const testEachRejectedPromise: {
     <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseRejectionTuple<FunctionType>>): void;
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseRejectionTuple<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseRejectionTuple<FunctionType>>): void;
 };
+/**
+ * Tests each given test set (expected value follows by various list of
+ * function parameters). It respects function signature to raise compile time
+ * errors if given test set does not match given function signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param functionTestTuple - Additional arrays of test sets to test given
+ * function again.
+ */
+export declare const testEachRejectedPromiseAgainstResolvedPromise: {
+    <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseRejectionAgainstResolvedPromiseTuple<FunctionType>>): void;
+    only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseRejectionAgainstResolvedPromiseTuple<FunctionType>>): void;
+    skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, ...functionTestTuple: Array<FunctionTestPromiseRejectionAgainstResolvedPromiseTuple<FunctionType>>): void;
+};
 /**
  * Tests each given single parameter against same given expected value. It
  * respects function signature to raise compile time errors if given test set
@@ -76,11 +115,26 @@ export declare const testEachSingleParameterAgainstSameExpectation: {
  * @param expected - Value to check each function call return value against.
  * @param parameters - Additional first parameters to test given function with.
  */
-export declare const testEachSingleParameterAgainstSamePromisedExpectation: {
+export declare const testEachResolvedPromiseWithSingleParameterAgainstSameExpectation: {
     <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...parameters: Array<FirstParameter<FunctionType>>): void;
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...parameters: Array<FirstParameter<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...parameters: Array<FirstParameter<FunctionType>>): void;
 };
+/**
+ * Tests each given single parameter against same given promises resolving to
+ * expected value. It respects function signature to raise compile time errors
+ * if given test set does not match given function signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param expected - Promise resolving to value to check each function call
+ * return value against.
+ * @param parameters - Additional first parameters to test given function with.
+ */
+export declare const testEachResolvedPromiseWithSingleParameterAgainstSameResolvedPromise: {
+    <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<TestSymbol | ThenParameter<ReturnType<FunctionType>>>, ...parameters: Array<FirstParameter<FunctionType>>): void;
+    only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<TestSymbol | ThenParameter<ReturnType<FunctionType>>>, ...parameters: Array<FirstParameter<FunctionType>>): void;
+    skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<TestSymbol | ThenParameter<ReturnType<FunctionType>>>, ...parameters: Array<FirstParameter<FunctionType>>): void;
+};
 /**
  * Tests each given single parameter against same given expected value. It
  * respects function signature to raise compile time errors if given test set
@@ -90,11 +144,25 @@ export declare const testEachSingleParameterAgainstSamePromisedExpectation: {
  * @param expected - Value to check each function call return value against.
  * @param parameters - Additional first parameters to test given function with.
  */
-export declare const testEachSingleParameterAgainstSameRejectedExpectation: {
+export declare const testEachRejectedPromiseWithSingleParameterAgainstSameExpectation: {
     <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...parameters: Array<FirstParameter<FunctionType>>): void;
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...parameters: Array<FirstParameter<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...parameters: Array<FirstParameter<FunctionType>>): void;
 };
+/**
+ * Tests each given single parameter against same given expected value. It
+ * respects function signature to raise compile time errors if given test set
+ * does not match given function signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param expected - Value to check each function call return value against.
+ * @param parameters - Additional first parameters to test given function with.
+ */
+export declare const testEachRejectedPromiseWithSingleParameterAgainstSameResolvedPromise: {
+    <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<Error | TestSymbol>, ...parameters: Array<FirstParameter<FunctionType>>): void;
+    only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<Error | TestSymbol>, ...parameters: Array<FirstParameter<FunctionType>>): void;
+    skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<Error | TestSymbol>, ...parameters: Array<FirstParameter<FunctionType>>): void;
+};
 /**
  * Tests each given test set (various list of function parameters) against same
  * given expected value. It respects function signature to raise compile time
@@ -120,11 +188,28 @@ export declare const testEachAgainstSameExpectation: {
  * @param functionParameters - Additional lists of parameters to test given
  * function again.
  */
-export declare const testEachPromiseAgainstSameExpectation: {
+export declare const testEachResolvedPromiseAgainstSameExpectation: {
     <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...functionParameters: Array<Parameters<FunctionType>>): void;
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...functionParameters: Array<Parameters<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: TestSymbol | ThenParameter<ReturnType<FunctionType>>, ...functionParameters: Array<Parameters<FunctionType>>): void;
 };
+/**
+ * Tests each given test set (various list of function parameters) against same
+ * given promise resolving expected value. It respects function signature to
+ * raise compile time errors if given test set does not match given function
+ * signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param expected - Promise resolving to value to check each function call
+ * return value against.
+ * @param functionParameters - Additional lists of parameters to test given
+ * function again.
+ */
+export declare const testEachResolvedPromiseAgainstSameResolvedPromise: {
+    <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<TestSymbol | ThenParameter<ReturnType<FunctionType>>>, ...functionParameters: Array<Parameters<FunctionType>>): void;
+    only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<TestSymbol | ThenParameter<ReturnType<FunctionType>>>, ...functionParameters: Array<Parameters<FunctionType>>): void;
+    skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<TestSymbol | ThenParameter<ReturnType<FunctionType>>>, ...functionParameters: Array<Parameters<FunctionType>>): void;
+};
 /**
  * Tests each given test set (various list of function parameters) against same
  * given expected value. It respects function signature to raise compile time
@@ -135,9 +220,26 @@ export declare const testEachPromiseAgainstSameExpectation: {
  * @param functionParameters - Additional lists of parameters to test given
  * function again.
  */
-export declare const testEachPromiseRejectionAgainstSameExpectation: {
+export declare const testEachRejectedPromiseAgainstSameExpectation: {
     <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...functionParameters: Array<Parameters<FunctionType>>): void;
     only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...functionParameters: Array<Parameters<FunctionType>>): void;
     skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Error | TestSymbol, ...functionParameters: Array<Parameters<FunctionType>>): void;
 };
+/**
+ * Tests each given test set (various list of function parameters) against same
+ * given promise resolving expected value. It respects function signature to
+ * raise compile time errors if given test set does not match given function
+ * signature.
+ * @param functionName - Function description to test.
+ * @param callback - Function reference to test.
+ * @param expected - Promise resolving to value to check each function call
+ * return value against.
+ * @param functionParameters - Additional lists of parameters to test given
+ * function again.
+ */
+export declare const testEachRejectedPromiseAgainstSameResolvedPromise: {
+    <FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<Error | TestSymbol>, ...functionParameters: Array<Parameters<FunctionType>>): void;
+    only<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<Error | TestSymbol>, ...functionParameters: Array<Parameters<FunctionType>>): void;
+    skip<FunctionType extends AnyFunction = UnknownFunction>(functionName: string, callback: FunctionType, expected: Promise<Error | TestSymbol>, ...functionParameters: Array<Parameters<FunctionType>>): void;
+};
 export default testEach;