index.d.ts 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. declare let spies: Set<SpyImpl<any[], any>>;
  2. declare type ReturnError = ['error', any];
  3. declare type ReturnOk<R> = ['ok', R];
  4. declare type ResultFn<R> = ReturnError | ReturnOk<R>;
  5. interface Spy<A extends any[] = any[], R = any> {
  6. called: boolean;
  7. callCount: number;
  8. calls: A[];
  9. length: number;
  10. results: ResultFn<R>[];
  11. returns: R[];
  12. nextError(error: any): this;
  13. nextResult(result: R): this;
  14. reset(): void;
  15. impl: ((...args: A) => R) | undefined;
  16. next: ResultFn<R> | null;
  17. }
  18. interface SpyImpl<A extends any[] = any[], R = any> extends Spy<A, R> {
  19. getOriginal(): (...args: A) => R;
  20. willCall(cb: (...args: A) => R): this;
  21. restore(): void;
  22. }
  23. interface SpyFn<A extends any[] = any[], R = any> extends Spy<A, R> {
  24. (...args: A): R;
  25. new (...args: A): R;
  26. }
  27. declare function spy<A extends any[], R>(cb?: ((...args: A) => R) | {
  28. new (...args: A): R;
  29. }): SpyFn<A, R>;
  30. declare type Procedure = (...args: any[]) => any;
  31. declare type Methods<T> = {
  32. [K in keyof T]: T[K] extends Procedure ? K : never;
  33. }[keyof T];
  34. declare type Getters<T> = {
  35. [K in keyof T]: T[K] extends Procedure ? never : K;
  36. }[keyof T];
  37. declare type Classes<T> = {
  38. [K in keyof T]: T[K] extends new (...args: any[]) => any ? K : never;
  39. }[keyof T];
  40. declare function spyOn<T, S extends Getters<Required<T>>>(obj: T, methodName: {
  41. setter: S;
  42. }, mock?: (arg: T[S]) => void): SpyImpl<[T[S]], void>;
  43. declare function spyOn<T, G extends Getters<Required<T>>>(obj: T, methodName: {
  44. getter: G;
  45. }, mock?: () => T[G]): SpyImpl<[], T[G]>;
  46. declare function spyOn<T, M extends Classes<Required<T>>>(object: T, method: M): Required<T>[M] extends new (...args: infer A) => infer R ? SpyImpl<A, R> : never;
  47. declare function spyOn<T, M extends Methods<Required<T>>>(obj: T, methodName: M, mock?: T[M]): Required<T>[M] extends (...args: infer A) => infer R ? SpyImpl<A, R> : never;
  48. declare function restoreAll(): void;
  49. export { Spy, SpyFn, SpyImpl, restoreAll, spies, spy, spyOn };