MockIT API 🚀

Professional mock data generator with TypeScript support and intelligent IntelliSense.

Features ✨

• TypeScript Support: Full type safety with excellent IntelliSense
• Multiple Categories: Users, Products, Posts, Comments, Companies
• Localization: English and Bengali language support
• Seeded Random: Reproducible data generation
• Professional Data: Realistic mock data for development
• Zero Dependencies: Lightweight and fast

Installation 📦

npm install mockit-api
# or
yarn add mockit-api

Quick Start 🚀

import { MockAPI } from 'mockit-api';

// Generate 10 users with optional fields
const users = MockAPI.users({ count: 10, includeOptional: true });

// Generate products with Bengali locale
const products = MockAPI.products({ count: 5, locale: 'bn' });

// Generate posts
const posts = MockAPI.posts({ count: 3 });

API Reference 📚

MockAPI.get(category, options)

Generate mock data for any category.

const data = MockAPI.get('users', {
  count: 10,           // Number of items to generate
  locale: 'en',        // Language: 'en' | 'bn'
  includeOptional: true, // Include optional fields
  seed: 12345          // Seed for reproducible data
});

Type-Safe Methods

// These methods provide full TypeScript support
const users = MockAPI.users({ count: 5 });
const products = MockAPI.products({ count: 10 });
const posts = MockAPI.posts({ count: 3 });

Available Categories

• users - User profiles with contact info
• products - E-commerce products with pricing
• posts - Blog posts with metadata
• comments - User comments
• companies - Company information
• addresses - Address data

Examples 💡

Basic Usage

import MockAPI from 'mockit-api';

// Simple generation
const users = MockAPI.users();
console.log(users);
// [{ id: 1, name: 'John Doe', email: '[email protected]', phone: '+11234567890' }]

Advanced Usage

import { MockAPI, User } from 'mockit-api';

// Generate comprehensive user data
const users: User[] = MockAPI.users({
  count: 50,
  locale: 'bn',
  includeOptional: true,
  seed: 42 // Reproducible results
});

// Users will have avatar, address, company, etc.

Seeded Generation

// Generate same data every time
const data1 = MockAPI.users({ seed: 123 });
const data2 = MockAPI.users({ seed: 123 });
// data1 === data2 (same results)

TypeScript Support 🎯

MockIT API provides excellent TypeScript support with:

• Full type definitions for all data structures
• IntelliSense autocomplete
• Type-safe method calls
• Interface exports for custom usage

import { User, Product, MockOptions } from 'mockit-api';

// Type-safe usage
const users: User[] = MockAPI.users({ count: 10 });
const products: Product[] = MockAPI.products({ count: 5 });

Contributing 🤝

We welcome contributions! Please see our Contributing Guide for details.

License 📄

MIT License - see LICENSE file for details.

Support 💬

• 📧 Email: [email protected]
• 🐛 Issues: GitHub Issues
• 📖 Docs: Documentation

Made with ❤️ by ALTAF