How to Mock Data for Node.js Applications using faker.js

When we start to build an application, we generally do not want to worry much about data. To create a database and fill it with sample data seems much of a hassle to me personally. I instead focus more on creating RESTful API and the front end of the application when I am prototyping.

However, this doesn’t mean I don’t pay attention to data organization in the database. It’s important to have schemas of collections and documents or any other way you want to organize your data. With this aspect complete, it clarifies what and how questions when creating APIs.

In a recent scenario, building a prototype of an E-Commerce web application for a client, I found myself in a similar situation. I had a deadline to deliver the prototype with a maximum number of functionalities checked required by the client. After settling on how to architecture database’s schemas, I went on searching​ and finding a gem to solve this issue: faker.js.

It’s a wonderful node module to create fake/mock data when you face a similar situation. fakerjs has its own API, and it’s huge. All credit goes to Marak, who built it. It has a vast API for almost every use case with an excellent documentation that can help you get familiar in minutes on Github.

Let’s consider a test case where I want some a user to have the following amount of fields:

• name
• email
• website
• address
• bio
• image/avatar

Copy
1const faker = require('faker');
2
3const User = {
4  name: faker.name.findName(),
5  email: faker.internet.email(),
6  website: faker.internet.url(),
7  address:
8    faker.address.streetAddress() +
9    faker.address.city() +
10    faker.address.country(),
11  bio: faker.lorem.sentences(),
12  image: faker.image.avatar()
13};
14
15module.exports = User;

That’s it. This is how you mock data using faker.js. It’s quick, simple to setup and no hassle at all. You just have to add it to your npm dependencies:

Copy
npm install faker --save

List of data that can generate faker.js:

• address
• commerce
• company
• date
• finance
• hacker
• helpers
• image
• internet
• lorem
• name
• phone
• random
• system

Each element has many sub-items that you can check here in the documentation.

Another good thing about Faker I like is that it’s not only restricted to server-side JavaScript only. You can mock data for browser JavaScript too. A little snippet from the documentation shows how to do this:

Copy
1<script src="faker.js" type="text/javascript"></script>
2<script>
3  var randomName = faker.name.findName(); // Caitlyn Kerluke
4  var randomEmail = faker.internet.email(); // Rusty@arne.info
5  var randomCard = faker.helpers.createCard(); // random contact card containing many properties
6</script>

This API will help you to prototype your JavaScript/Node.js applications at a faster rate. Not only that, you can easily mock your TDD/BDD tests when creating a RESTful API utilizing this library.

For full source code at this Github Repository