Skip to content

responserun/responserun-mock

Repository files navigation

responserun-mock

Overview

responserun-mock is a simple TypeScript library that allows developers to generate names. surname , etc. It provides functions for creating random mock data

Installation

npm install --save-dev responserun-mock

example

const { createMaleFirstName, Locale, multipleRandomizer } = require('responserun-mock');


const turkishMaleName = createMaleFirstName(Locale.tr);

// multiple create object
const random = multipleRandomizer(
  () => ({
    name: createMaleFirstName(Locale.tr),
  }),
    5
  );

console.log(`Random Turkish Male Name: ${turkishMaleName}`);
console.log(random);

jsx example

import { useEffect, useState } from "react";
import {
  Locale,
  createAddress,
  createFemaleFirstName,
  createSurname,
  generateUuid4,
  multipleRandomizer,
} from "responserun-mock";

type User = {
  id: string;
  name: string;
  surname: string;
  address: string;
}

const TestPage = () => {
  const [users, setUsers] = useState<User[]>([]);

  useEffect(() => {
    const userList = multipleRandomizer(
      () => ({
        id: generateUuid4(),
        name: createFemaleFirstName(Locale.tr),
        surname: createSurname(Locale.tr),
        address: createAddress(Locale.tr),
      }),
      5
    );
    setUsers(userList);
  }, []);

  return (
    <div className="p-2">
      <ul>
        {users.map((user) => {
          return (
            <li key={user.id}>
              {user.name} {user.surname}
            </li>
          );
        })}
      </ul>
    </div>
  );
};

export default TestPage;

Wiki

For more information, please check our Wiki page.

Tests

The project includes a suite of tests. To ensure they run successfully, use the following command:

npm test

Additionally, to check code coverage, you can use the following command:

npm run coverage

This command generates a coverage report indicating how much of the code is covered by the tests. You can access the detailed report here

License

This project is licensed under the MIT License - see the LICENSE file for details.