","directories":{},"_nodeVersion":"22.14.0","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","prettier":"^3.6.0","@types/bun":"^1.2.17","typescript":"^5.8.3","expect-type":"^0.19.0"},"_npmOperationalInternal":{"tmp":"tmp/mockemon_4.5.2_1750801874474_0.2509423678125833","host":"s3://npm-registry-packages-npm-production"}},"4.5.4":{"name":"mockemon","version":"4.5.4","repository":{"type":"git","url":"git+https://github.com/Glinkis/mockemon.git"},"author":{"name":"Victor Glindås","email":"glinkis@gmail.com"},"license":"MIT","main":"./dist/builder.js","module":"./dist/builder.mjs","types":"./dist/builder.d.ts","exports":{"./package.json":"./package.json",".":{"import":{"types":"./dist/builder.d.mts","default":"./dist/builder.mjs"},"require":{"types":"./dist/builder.d.ts","default":"./dist/builder.js"}}},"scripts":{"test":"bun test","build":"bun run tsdown","prepublishOnly":"bun run build"},"devDependencies":{"@types/bun":"^1.2.17","expect-type":"^0.19.0","prettier":"^3.6.0","tsdown":"^0.12.9","typescript":"^5.8.3"},"prettier":{"printWidth":120},"keywords":["mocking","mock","faker","test","testing","builder","factory"],"_id":"mockemon@4.5.4","gitHead":"d3231bf3f912af0300284c53c4cb091f97bb8ca3","description":"
Mockemon 🏗️
","bugs":{"url":"https://github.com/Glinkis/mockemon/issues"},"homepage":"https://github.com/Glinkis/mockemon#readme","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-gkuEepCJSVu5EFWBZDOVz0d+8LTaTUvo9FSmETLvAS9pZy0nwdl2asjzhsnH/0n/U3Wr0PFgrKdPJCDp4CvUeg==","shasum":"d4451aeaed154774dac2da5dfd43a976d27f1441","tarball":"https://registry.npmjs.org/mockemon/-/mockemon-4.5.4.tgz","fileCount":7,"unpackedSize":12471,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICap/QOiRZEcfh/G5eMxnL5eavOdkURkfSSisVr7c7wzAiBNc8PBK0vAA9Wq4PSHXGV1+aDpXBy8CVPEm/KB+1fyFA=="}]},"_npmUser":{"name":"glinkis","email":"glinkis@gmail.com","actor":{"name":"glinkis","email":"glinkis@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"glinkis","email":"glinkis@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mockemon_4.5.4_1750885893249_0.5344839751128436"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-13T22:10:12.211Z","modified":"2025-06-25T21:11:33.619Z","1.0.0":"2023-11-13T22:10:12.542Z","1.0.1":"2023-11-13T22:16:28.445Z","1.0.2":"2023-11-13T22:36:16.333Z","1.0.3":"2023-11-13T22:38:48.632Z","1.1.0":"2023-11-14T18:39:21.083Z","1.1.1":"2023-11-14T18:51:48.170Z","1.2.0":"2023-11-14T21:32:33.719Z","1.2.1":"2023-11-14T21:39:19.836Z","1.2.2":"2023-11-14T21:46:39.311Z","1.3.0":"2023-11-15T14:09:08.966Z","1.3.1":"2023-11-15T14:14:16.494Z","1.3.2":"2023-11-15T14:28:30.357Z","1.3.3":"2023-11-15T14:30:21.706Z","1.4.0":"2023-11-15T16:39:16.847Z","1.5.1":"2023-11-15T21:21:35.920Z","1.5.2":"2023-11-15T21:26:18.362Z","2.0.0":"2023-11-15T21:39:51.155Z","2.0.1":"2023-11-16T15:35:03.787Z","2.0.2":"2023-11-16T19:01:37.281Z","2.0.3":"2023-11-16T19:06:13.238Z","3.0.0":"2023-11-16T19:28:10.648Z","3.1.0":"2023-11-19T22:01:27.181Z","4.0.0":"2024-05-24T17:33:13.677Z","4.0.1":"2024-05-24T19:01:39.741Z","4.1.0":"2024-05-24T22:25:26.023Z","4.1.1":"2024-05-24T22:42:42.416Z","4.2.0":"2024-05-28T17:57:53.177Z","4.2.1":"2024-05-28T18:16:27.843Z","4.2.2":"2024-05-29T19:36:12.870Z","4.2.3":"2024-05-29T19:38:21.086Z","4.2.4":"2024-05-29T20:10:18.191Z","4.2.5":"2024-05-29T20:45:30.021Z","4.2.6":"2024-05-29T21:10:35.398Z","4.2.7":"2024-06-12T08:13:50.172Z","4.3.0":"2025-06-24T16:56:00.405Z","4.4.0":"2025-06-24T19:32:40.440Z","4.4.1":"2025-06-24T19:45:43.344Z","4.5.0":"2025-06-24T19:51:03.979Z","4.5.1":"2025-06-24T19:53:14.932Z","4.5.2":"2025-06-24T21:51:14.662Z","4.5.4":"2025-06-25T21:11:33.438Z"},"bugs":{"url":"https://github.com/Glinkis/mockemon/issues"},"author":{"name":"Victor Glindås","email":"glinkis@gmail.com"},"license":"MIT","homepage":"https://github.com/Glinkis/mockemon#readme","keywords":["mocking","mock","faker","test","testing","builder","factory"],"repository":{"type":"git","url":"git+https://github.com/Glinkis/mockemon.git"},"description":"
Mockemon 🏗️
","maintainers":[{"name":"glinkis","email":"glinkis@gmail.com"}],"readme":"
\n
Mockemon 🏗️
\n\n
A tiny agnostic mocking utility library, with a strong focus on type safety.
\n\n
\n\n[jsrpackage]: https://jsr.io/@glinkis/mockemon\n[npmpackage]: https://www.npmjs.com/package/mockemon\n[npmtrends]: http://www.npmtrends.com/mockemon\n\n[][jsrpackage]\n[][npmpackage]\n[][npmtrends]\n\n## Installation\n\nInstall with your favorite package manager.\n\n```sh\nnpm install mockemon\n```\n\n```sh\nyarn add mockemon\n```\n\n```sh\nbun add mockemon\n```\n\n## The Mock Builder\n\nThe builder utility allows you to create strongly typed mocks for your tests, or anywhere else.\n\n### Configuration\n\nTo use the builder, you must first configure it. This is done by importing and calling `configureMockBuilder`\n\n```ts\nimport { configureMockBuilder } from \"mockemon\";\nimport { faker } from \"@faker-js/faker\";\n\nconst createMockBuilder = configureMockBuilder({\n // A value that will be passed as the argument to all mock builders.\n // This is often a faker instance, but can be anything.\n context: faker,\n});\n```\n\n### Usage\n\nOnce the builder is configured, you can start creating mock builders.\n\n```ts\nconst buildPetOwner = createMockBuilder((f) => ({\n name: f.person.firstName(),\n pet: f.animal.cat(),\n}));\n```\n\nThe mock builder will automatically infer the type from the provided mock builder function.\n\n```ts\nconst petOwner = buildPetOwner();\n// { name: string, pet: string }\n```\n\n### Overrides\n\nPassing a value to the builder will override the default value.\n\n```ts\nconst petOwner = buildPetOwner({\n pet: \"Daisy\" as const,\n});\n// { name: string, pet: \"Daisy\" }\n```\n\nIt's also possible to pass a function to the builder. This function will be called with the provided faker instance, just like when setting up the builder initially.\n\n```ts\nconst petOwner = buildPetOwner((f) => ({\n pet: f.helpers.arrayElement([\"Daisy\", \"Bella\", \"Luna\"] as const]),\n}));\n// { name: string, pet: \"Daisy\" | \"Bella\" | \"Luna\" }\n```\n\n### Mocking Other Types\n\nThe builder can also be used to mock other types of values as well, such as primitives or arrays.\n\n```ts\n// Mocks a string value\nconst buildName = createMockBuilder((f) => f.person.fullName());\n\nconst name1 = buildName();\nconst name2 = buildName(\"John Doe\");\nconst name3 = buildName((f) => f.person.lastName());\n```\n\n```ts\n// Mocks an array\nconst buildNames = createMockBuilder((f) => {\n return f.helpers.multiple(() => f.person.fullName());\n});\n\nconst names1 = buildNames();\nconst names2 = buildNames([\"John Doe\", \"Jane Doe\"]);\nconst names3 = buildNames((f) => {\n return f.helpers.multiple(() => f.person.lastName());\n});\n```\n\n### Advanced Patterns\n\n#### Combining Builders\n\nIf you have a value that is a superset of another, you can reuse the builder of the subset in the builder of the superset by simply spreading it.\n\n```ts\ninterface Person {\n name: string;\n age: number;\n}\n\nconst buildPerson = createMockBuilder(\n (f): Person => ({\n name: f.person.firstName(),\n age: f.number.int(),\n }),\n);\n\ninterface PetOwner extends Person {\n pet: string;\n}\n\nconst buildPetOwner = createMockBuilder(\n (f): PetOwner => ({\n ...buildPerson(),\n pet: f.animal.cat(),\n }),\n);\n```\n\n```ts\nconst buildCatNames = createMockBuilder((f) => {\n return f.helpers.shuffle([\"Daisy\", \"Bella\", \"Luna\"]);\n});\n\nconst buildDogNames = createMockBuilder((f) => {\n return f.helpers.shuffle([\"Max\", \"Charlie\", \"Cooper\"]);\n});\n\nconst buildPets = createMockBuilder((f) => {\n return f.helpers.shuffle([...buildCatNames(), ...buildDogNames()]);\n});\n```\n","readmeFilename":"README.md"}