Quick Mock Data Generator

Need test data quickly? This utility helps you generate realistic mock data fast. Choose from common properties like names, emails, and dates, or define your own generators. Perfect for prototypes, tests, and demos where you need meaningful data right away.

Built on top of @faker-js/faker, it provides a simpler interface while maintaining type safety and full TypeScript support.

Key features:

• 🚀 Quick property selection from common data types
• 🎯 Generate exactly what you decide, nothing more
• 📦 Zero configuration required
• 🔍 Full TypeScript support with autocompletion

Installation

Using Deno

deno add jsr:@functions/mock

Using npm / pnpm / or others

npx jsr add @functions/mock
pnpm dlx jsr add @functions/mock
yarn dlx jsr add @functions/mock
bunx jsr add @functions/mock

Usage

Generate Mock Data with Specific Properties

The getMocksWith function allows you to pick from a predefined set of common properties (like name, email, age, avatar, etc.) and quickly generate objects containing just those properties. Perfect for creating test data with exactly what you need in a fast way:

This basically returns a function that will create mock data based on a list of predefined properties.

import { getMocksWith } from '@functions/mock'

const createRandomUsers = getMocksWith(['name', 'age', 'email']) // Autosuggestion helps you pick the props 
const users = createRandomUsers(3)
//[ { name:"John", age: 64, email: "random@mail.net" }, etc... ]

Generate Mock Data from a Generator

The getMocksFromGenerator function lets you define your own data generation logic. You provide an object where each property is a function that generates values. You can mix and match:

• Faker.js functions
• Your own custom functions
• Random value generators
• Fixed value functions
• Any JavaScript/TypeScript function that returns a value

import { getMocksFromGenerator } from '@functions/mock'
import { faker } from '@faker-js/faker'

const yourGenerator = {
	id: faker.string.uuid,
	age: () => Math.floor(Math.random() * (100 - 18 + 1)) + 18,
	username: () => `user_${faker.number.int(1000)}`,
	role: () => 'user',
	// Complex custom logic
	status: () => {
		const statuses = ['active', 'inactive', 'pending']
		return statuses[Math.floor(Math.random() * statuses.length)]
	},
}

const createRandomObjects = getMocksFromGenerator(yourGenerator)
// TypeScript also infers return types from your generator functions
const objects = createRandomObjects(5)
// [{ id: '...', age: 42, username: 'user_123', role: 'user', status: 'active' },

Contributing

This is a Test-Driven Development (TDD) project. Please read the Contributing Guidelines for details on development process and how to submit pull requests.

License

This project is licensed under the MIT License.