Merge pull request #437 from mohaalak/types_for_stubbing

update td.when types

Author: searls

index.d.ts

@@ -2,21 +2,21 @@
 // types and interfaces
 // ----------------------------------------------------------------------------
 
-export type DoubledObject < T > = T
+export type DoubledObject<T> = T;
 
-export type DoubledObjectWithKey < T extends string > = { [K in T] : any }
+export type DoubledObjectWithKey<T extends string> = { [K in T]: any };
 
-export type TestDouble < T > = T
+export type TestDouble<T> = T;
 
-export type TestDoubleConstructor < T > = Constructor<T>
+export type TestDoubleConstructor<T> = Constructor<T>;
 
 interface Call {
   context: {};
   args: any[];
 }
 
 interface Constructor<T> {
-  new (...args: any[]): T
+  new (...args: any[]): T;
 }
 
 export interface Captor {
@@ -49,15 +49,21 @@ export interface Matchers {
   create(config: MatcherConfig): any;
 }
 
-export const matchers: Matchers
+export const matchers: Matchers;
 
-export interface Stubber {
-  thenReturn<T>(...args: any[]): TestDouble<T>;
+export interface Stubber<D, R = D extends object ? Partial<D> : D> {
+  thenReturn<T>(first: R, ...args: Array<R>): TestDouble<T>;
   thenDo<T>(f: Function): TestDouble<T>;
   thenThrow<T>(e: Error): TestDouble<T>;
-  thenResolve<T>(...args: any[]): TestDouble<T>;
+  thenResolve<T>(first: R, ...args: Array<R>): TestDouble<T>;
+  thenReject<T>(e: Error): TestDouble<T>;
+  thenCallback<T>(error: any, data: any): TestDouble<T>;
+}
+
+export interface PromiseStubber<P, R = P extends object ? Partial<P> : P> {
+  thenResolve<T>(first: R, ...args: Array<R>): TestDouble<T>;
+  thenDo<T>(f: Function): TestDouble<T>;
   thenReject<T>(e: Error): TestDouble<T>;
-  thenCallback<T>(...args: any[]): TestDouble<T>;
 }
 
 export interface TestdoubleConfig {
@@ -72,6 +78,14 @@ export interface VerificationConfig {
   cloneArgs?: boolean;
 }
 
+export interface WhenConfig {
+  ignoreExtraArgs?: boolean;
+  times?: number;
+  cloneArgs?: boolean;
+  defer?: boolean;
+  delay?: number;
+}
+
 //
 // general
 // ----------------------------------------------------------------------------
@@ -117,7 +131,9 @@ export function explain<T>(f: TestDouble<T>): Explanation;
  * @param {{ new (...args: any[]): T }} constructor
  * @returns {DoubledObject<T>}
  */
-export function constructor<T>(constructor: Constructor<T>): TestDoubleConstructor<T>;
+export function constructor<T>(
+  constructor: Constructor<T>
+): TestDoubleConstructor<T>;
 
 //
 // fake: functions
@@ -140,8 +156,8 @@ declare function functionDouble(name?: string): TestDouble<Function>;
  */
 declare function functionDouble<T>(name?: T): TestDouble<T>;
 
-export { functionDouble as function }
-export { functionDouble as func }
+export { functionDouble as function };
+export { functionDouble as func };
 
 //
 // fake: objects
@@ -207,7 +223,10 @@ export function object<T>(object: T): DoubledObject<T>;
  * @param {string} [name]
  * @returns {TestDoubleConstructor<T>}
  */
-export function imitate<T>(constructor: Constructor<T>, name?: string): TestDoubleConstructor<T>;
+export function imitate<T>(
+  constructor: Constructor<T>,
+  name?: string
+): TestDoubleConstructor<T>;
 
 /**
  * Create a fake object or function.
@@ -262,8 +281,8 @@ export function replace(path: {}, property: string, f?: any): any;
  * @param {...any[]} args
  * @returns {Stubber}
  */
-export function when(...args: any[]): Stubber;
-
+export function when<P>(f: Promise<P>, config?: WhenConfig): PromiseStubber<P>;
+export function when<D>(f: D, config?: WhenConfig): Stubber<D>;
 /**
  * Verify a specific function call to a stubbed function.
  *

test/safe/typescript-typings.test.ts

@@ -6,7 +6,9 @@ class Dog {
 }
 
 class Cat {
-  meow (): string { return 'meow! meow!' }
+  meow (): string {
+    return 'meow! meow!'
+  }
 }
 
 function sum (first: number, second: number): number {
@@ -18,19 +20,36 @@ export = {
     const dog = td.constructor(Dog)
     td.when(dog.prototype.bark()).thenReturn('woof!')
 
-    const bird = td.object({ fly: function () {} })
+    const bird = td.object({
+      fly: function (): string {
+        return 'swoosh'
+      }
+    })
     td.when(bird.fly()).thenReturn('swoosh!')
 
+    const fish = td.object<{
+      swim(): { speed: number; direction: number };
+    }>()
+    td.when(fish.swim()).thenReturn({ speed: 100 })
+
     const kitty = td.object(['scratch', 'meow'])
     td.when(kitty.scratch()).thenReturn('scratch!')
     td.when(kitty.meow()).thenReturn('meow!')
 
-    if (eval('typeof Proxy') !== 'undefined') { // eslint-disable-line
-      class Bear { sleep () {} }
+    // eslint-disable-next-line
+    if (eval("typeof Proxy") !== "undefined") {
+      class Bear {
+        sleep (): string {
+          return 'test'
+        }
+      }
 
       const FakeBear = td.constructor<Bear>(Bear)
 
-      assert.strictEqual(td.explain(FakeBear.prototype.sleep).isTestDouble, true)
+      assert.strictEqual(
+        td.explain(FakeBear.prototype.sleep).isTestDouble,
+        true
+      )
 
       const bear = td.object<Bear>('A bear')
 
@@ -51,7 +70,9 @@ export = {
     const f = td.function()
     td.when(f(10)).thenReturn(10, 11)
     td.when(f(1)).thenThrow(new Error('ok'))
-    td.when(f(td.matchers.isA(String))).thenDo(function (s: string) { return s })
+    td.when(f(td.matchers.isA(String))).thenDo(function (s: string) {
+      return s
+    })
     td.when(f(td.matchers.not(true))).thenResolve('value1', 'value2')
     td.when(f(td.matchers.not(false))).thenReject(new Error('rejected'))
 
@@ -78,4 +99,4 @@ export = {
       'This test double has 5 stubbings and 1 invocations.'
     )
   }
-}
+};