README.md

randomuser

A tiny NodeJS client for generating random users - https://randomuser.me.

Installation

1. Install dependencies with yarn
2. Build the project with yarn build
3. Run tests with yarn test

Getting started

const RandomUser = require('randomuser');
const client = new RandomUser();

// With options
client.getUsers({ seed: "foxie", results: 5, gender: "male" }, data => {
  console.log(data);
});

// Without options
client.getUsers(data => {
  console.log(data);
});

params {Object} Documentation

• results - number specifying number of results to return
• genders - string - "male" or "female" specifying gender to generate
• seed - string - service will return same data for given seed

Contributing

Feel free to contribute!