Changed to createFixture

rEaDMe.md

@@ -39,15 +39,20 @@ it("Should return an id", () => {
 });
 ```
 
-## Pass types to
+## API
 
 ### `fromExact`
 
+TODO
+
 ### `fromAny`
 
+TODO
+
 ### `fromPartial`
 
-`fromPartial` lets you pass a deep partial of an object to a slot expecting that
-object. This is
+TODO
+
+## `createFixture`
 
-## `createMock`
+TODO

src/createMock.ts → src/createFixture.ts

@@ -1,9 +1,11 @@
 import { Base } from "./types";
 
-const _createMock = <T, Default = {}>(fixture: Default): Base<T, Default> => {
+const _createFixture = <T, Default = {}>(
+  fixture: Default
+): Base<T, Default> => {
   return {
     get: () => fixture as unknown as T,
-    set: (base) => _createMock(base),
+    set: (base) => _createFixture(base),
     fromExact: (mock) => {
       return {
         ...fixture,
@@ -25,6 +27,6 @@ const _createMock = <T, Default = {}>(fixture: Default): Base<T, Default> => {
  *
  * @returns
  */
-export const createMock = <T>(): Base<T> => {
-  return _createMock({});
+export const createFixture = <T>(): Base<T> => {
+  return _createFixture({});
 };

src/index.ts

@@ -1,3 +1,3 @@
 export * from "./types";
 export * from "./utils";
-export * from "./createMock";
+export * from "./createFixture";

src/playground.ts

@@ -1,5 +1,5 @@
 import { it } from "vitest";
-import { createMock } from "./createMock";
+import { createFixture } from "./createFixture";
 import { fromAny, fromPartial, fromExact } from "./utils";
 
 type User = {
@@ -9,7 +9,7 @@ type User = {
 
 const func = (user: User) => {};
 
-const baseUser = createMock<User>().set({
+const baseUser = createFixture<User>().set({
   id: "123123",
   name: "awdawd",
 });

tests/createMock.test.ts → tests/createFixture.test.ts

@@ -1,8 +1,8 @@
 import { describe, expect, it } from "vitest";
-import { createMock } from "../src";
+import { createFixture } from "../src";
 import { Equal, Expect } from "./test-utils";
 
-describe("createMock", () => {
+describe("createFixture", () => {
   type User = {
     id: number;
     name: string;
@@ -11,7 +11,7 @@ describe("createMock", () => {
     }[];
   };
 
-  const user = createMock<User>();
+  const user = createFixture<User>();
 
   it("Should start off with an empty object base, but should be assignable to the correct type", () => {
     const fixture = user.get();