# simpsonify

> Provides generic and customisable user test data with a Simpsons twist

Latest version **1.0.0** (published 2017-10-30) · 0 weekly downloads

## Install

```sh
npm install simpsonify
pnpm add simpsonify
yarn add simpsonify
bun add simpsonify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-10-30 |
| First published | 2017-10-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Georgia Barnett |
| Maintainers | georgia |

## Links

- npm: https://www.npmjs.com/package/simpsonify
- Repository: https://github.com/Georgia-B/Simpsonify
- Homepage: https://github.com/Georgia-B/Simpsonify#readme
- Issues: https://github.com/Georgia-B/Simpsonify/issues
- npm.io page: https://npm.io/package/simpsonify

## Recent versions

- 1.0.0 (latest) — 2017-10-30
- 0.0.1 — 2017-10-30

## README

# Simpsonify
Provides generic and customisable user test data with a Simpsons twist

**Check it out live in action [here](https://georgia-b.github.io/simpsonify-example/)!**

## Installation

`npm install simpsonify`

## Usage

User properties available:
- `firstName`: string - User first name
- `lastName`: string - User last name
- `email`: string - User email in valid format
- `avatarUrl`: string - Valid url to user avatar

### Available Methods
__`getUsers`__

Returns up to 28 unique Simpsons users with default properties and the option to include additional custom properties

Parameters:
 - `count`: desired number of user results returned
 - `customProps`: array of additional properties for each user. Each property object includes the property name and an array of possible values to be randomly selected from
 
 ### Example
 
 ```
 const props = [
    {
      name: 'occupation',
      values: ['Developer', 'Engineer', 'Teacher', 'Doctor']
    },
    {
      name: 'nationality'.
      values: ['New Zealand', 'Australia', 'Canada', 'Japan', 'Germany']
    }
 ];
 getUsers(5, props);
 ```

### Returns

```
[
   {
      firstName: 'Homer',
      lastName: 'Simpson',
      email: 'homer.simpson@springfield.com',
      avatarUrl: 'https://goo.gl/VBV6pj'
   },
   {
      firstName: 'Marge',
      lastName: 'Simpson',
      email: 'marge.simpson@springfield.com',
      avatarUrl: 'https://goo.gl/ULr95z'
   }
]
```

### Example Use Case

![screenshot](https://github.com/Georgia-B/Simpsonify/blob/master/example.png?raw=true)

---
_Source: https://npm.io/package/simpsonify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._