Skip to content

lffg-labs/faker-create-factory

Repository files navigation

faker-create-factory

🏭 Factory creator utility to Faker.js

Build Status NPM Uses TypeScript

Installing

yarn add faker faker-create-factory

# If you're using NPM:
# npm install faker faker-create-factory

Basic Usage

import { createFactory } from 'faker-create-factory';

export const UserFactory = createFactory<User>((faker) => ({
  id: faker.random.uuid(),
  email: faker.internet.email(),
  username: faker.internet.userName(),
  password: '123'
}));

// And the use it as:
UserFactory.generate(); // User
UserFactory.generateMany(5); // Array<User>

If needed, you can override the default schema:

import { createFactory } from 'faker-create-factory';

export const Factory = createFactory<Interface>((faker) => ({
  // ...
}));

// Plain object:
Factory.generate({
  // ...
});

// With a faker instance:
Factory.generateMany(5, (faker) => {
  // ...
});

The two options (plain object and with a faker instance) described above are available in both generate and generateMany methods.

Authors and License

lffg and contributors.

MIT License, see the included MIT file.

About

Factory creator utility to Faker.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published