tsmockit 2.0.0 → 2.0.1

package/Mock/Any.d.ts

@@ -1,2 +1,6 @@
 export declare const ANY_VALUE = "ANYTHING";
+/**
+ * Returns a value Mock understands to represent "ANYTHING" casted to "T"
+ * @returns
+ */
 export declare function Any<T>(): T;

package/Mock/Any.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Any = exports.ANY_VALUE = void 0;
 exports.ANY_VALUE = 'ANYTHING';
+/**
+ * Returns a value Mock understands to represent "ANYTHING" casted to "T"
+ * @returns
+ */
 function Any() {
     return exports.ANY_VALUE;
 }

package/Mock/Mock.d.ts

@@ -2,11 +2,38 @@ import { Times } from './Times';
 export declare class Mock<T> {
     private memberSignatureMaps;
     private object;
+    /**
+     * The mock object of the given type "T" to inject as a substitute to a concrete implementation
+     */
     get Object(): T;
+    /**
+     * Configure what the mock object will return when a given member is accessed
+     * @param member
+     * @param returns
+     */
     Setup(member: (func: T) => any, returns?: any): void;
+    /**
+     * Configure a setup that will only resolve on the first time the member is registered
+     * @param member
+     * @param returns
+     */
     SetupOnce(member: (func: T) => any, returns?: any): void;
+    /**
+     * Configure a set of setups that will only resolve on the first time the member is registered
+     * @param setups
+     */
     SetupSequence(setups: [(func: T) => any, any][]): void;
+    /**
+     * Return the number of times a given member was referenced
+     * @param member
+     * @returns
+     */
     TimesMemberCalled(member: (func: T) => any): number;
+    /**
+     * Make an assertion that a given member was referenced a given number of times
+     * @param member
+     * @param times
+     */
     Verify(member: (func: T) => any, times: Times | number): void;
     private setup;
     private getReturnValueForProperty;

package/Mock/Mock.js

@@ -9,32 +9,59 @@ var Mock = /** @class */ (function () {
         this.object = {};
     }
     Object.defineProperty(Mock.prototype, "Object", {
+        /**
+         * The mock object of the given type "T" to inject as a substitute to a concrete implementation
+         */
         get: function () {
             return this.object;
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * Configure what the mock object will return when a given member is accessed
+     * @param member
+     * @param returns
+     */
     Mock.prototype.Setup = function (member, returns) {
         if (returns === void 0) { returns = null; }
         this.setup(member, returns);
     };
+    /**
+     * Configure a setup that will only resolve on the first time the member is registered
+     * @param member
+     * @param returns
+     */
     Mock.prototype.SetupOnce = function (member, returns) {
         if (returns === void 0) { returns = null; }
         this.setup(member, returns, true);
     };
+    /**
+     * Configure a set of setups that will only resolve on the first time the member is registered
+     * @param setups
+     */
     Mock.prototype.SetupSequence = function (setups) {
         var _this = this;
         setups.forEach(function (setup) {
             _this.SetupOnce(setup[0], setup[1]);
         });
     };
+    /**
+     * Return the number of times a given member was referenced
+     * @param member
+     * @returns
+     */
     Mock.prototype.TimesMemberCalled = function (member) {
         var _a;
         var memberSignatureMap = SignatureService_1.SignatureService.GetMemberSignatureMap(member);
         var functionMap = this.getFunctionMapsFromSignature(memberSignatureMap, (_a = memberSignatureMap.functionMaps[0]) === null || _a === void 0 ? void 0 : _a.state).functionMapForArgs;
         return (functionMap === null || functionMap === void 0 ? void 0 : functionMap.timesCalled) || 0;
     };
+    /**
+     * Make an assertion that a given member was referenced a given number of times
+     * @param member
+     * @param times
+     */
     Mock.prototype.Verify = function (member, times) {
         var timesCalled = this.TimesMemberCalled(member);
         var signature = SignatureService_1.SignatureService.GetMemberSignatureMap(member).signature;

package/package.json

@@ -14,7 +14,7 @@
     "dependency injection"
   ],
   "license": "MIT",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Generic mocking library for TypeScript",
   "private": false,
   "main": "./public_api.js",