@slimlib/smart-mock 1.0.0 → 1.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 Yet another proxy mock (YAPM?). Still in a very early state (EXPECT BUGS!).
 
-Mock that records operations for code generation later. Idea is somewhat similar to `prepack` but instead of interpreting code by other JS code we run it in JS VM and later use mock to repeat the same operations. Ideally combined with a terser like optimizer. Please check the example in `pkgbld` how it is used to eject config.
+A mock that records operations for code generation later. The idea is somewhat similar to `prepack`, but instead of interpreting code by other JS code, we run it in a JS VM and later use the mock to repeat the same operations. Ideally combined with a terser-like optimizer. Please check the example in `pkgbld` to see how it is used to eject config.
 
 [Changelog](./CHANGELOG.md)
 
@@ -10,11 +10,11 @@ Mock that records operations for code generation later. Idea is somewhat similar
 
 ### default `() => { createMock, generateGlobals, generate }`
 
-Default export function is a factory that creates 3 other functions with shared state.
+The default export function is a factory that creates 3 other functions with shared state.
 
 ### `createMock<T extends object>(object: T, name: string): T`
 
-Function to create mock wrapper around object and defining global name for later usage. `object` can be a real original object or a pure mock object with the same behavior for the specific situation. All operations on this object will be recorded by mock.
+Function to create a mock wrapper around an object and define a global name for later usage. `object` can be a real original object or a pure mock object with the same behavior for the specific situation. All operations on this object will be recorded by the mock.
 
 ### `generate(object: unknown): string`
 
@@ -22,19 +22,24 @@ Function to generate code for some export point (exit point). It will try to aut
 
 ### `generateGlobals(): string`
 
-Function to generate global code that cannot be inlined to exit point.
+Function to generate global code that cannot be inlined to an exit point.
 
 ### Example
 
 ```javascript
-import createMockProvider from '@slimlib/smart-mock';
+import createMockProvider from "@slimlib/smart-mock";
 const { createMock, generate, generateGlobals } = createMockProvider();
-const mock = createMock({
-    fly() { return { status: 'flying' }; },
+const mock = createMock(
+  {
+    fly() {
+      return { status: "flying" };
+    },
     land() {},
-    name: ''
-}, 'fly');
-mock.name = 'Moth';
+    name: "",
+  },
+  "fly"
+);
+mock.name = "Moth";
 const status = mock.fly();
 mock.land();
 ```
@@ -42,12 +47,12 @@ mock.land();
 At this point `generate(mock)` will result in `mock`, `generate(mock.name)` in `'Moth'` and `generate(status)` in `fly.fly()`. And if you afterwards call `generateGlobals()` you get something like:
 
 ```javascript
-fly.name = "Moth"
-const tmp_0 = fly.land
-tmp_0()
+fly.name = "Moth";
+const tmp_0 = fly.land;
+tmp_0();
 ```
 
-Each `generate` call updates counters / flags in mock so `generateGlobals` only emits what was not generated at the time of call.
+Each `generate` call updates counters / flags in the mock so `generateGlobals` only emits what was not generated at the time of the call.
 
 # License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "name": "@slimlib/smart-mock",
   "description": "One more proxy based mock",
   "license": "MIT",