# mockachino

> Generate mock data for your apps. Take a sip and relax

Latest version **0.2.3** (published 2018-09-01) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2018-09-01 |
| First published | 2018-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 54.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Simao Nziaka |
| Maintainers | akaizn |
| Keywords | mock, fake, data, seed, mockachino, faker, mocker |

## Links

- npm: https://www.npmjs.com/package/mockachino
- Repository: https://github.com/akaizn-junior/mockachino
- Homepage: https://github.com/akaizn-junior/mockachino#readme
- Issues: https://github.com/akaizn-junior/mockachino/issues
- npm.io page: https://npm.io/package/mockachino

## Alternatives

- [pagerjs](https://npm.io/package/pagerjs.md) — 60 weekly downloads
- [whistle.savefor-mock](https://npm.io/package/whistle.savefor-mock.md) — 4 weekly downloads
- [@depup/casual](https://npm.io/package/@depup/casual.md) — 0 weekly downloads
- [@availity/mock-server](https://npm.io/package/@availity/mock-server.md) — 0 weekly downloads
- [@scotthuang/agent-knock-knock-pi](https://npm.io/package/@scotthuang/agent-knock-knock-pi.md) — 0 weekly downloads

## Recent versions

- 0.2.3 (latest) — 2018-09-01
- 0.2.2 — 2018-08-20
- 0.2.1 — 2018-08-18
- 0.2.0 — 2018-08-17
- 0.1.0 — 2018-08-15

## README

![Mockachino logo](./logo.gif)

- Faker
- Mocker
- Mocha?
- Mochachino?!

# Mockachino

Generate mock data for your apps, take a sip and relax!

    * People
    * Addresses
    * Phone Numbers
    * Jobs
    * Sentences
    * Paragraphs
    * Texts
    * Cities
    * & more

    Based on US data; other countries to come.

### [Documentation](https://akaizn-junior.github.io/mockachino/)

## How to use

### Script tag

```js
<script src="mockachino.min.js"></script>
<script>
    let mocka = new Mockachino().mock();
    //show mocked data in the console
    console.log(mocka.person);
    /*
    e.g: Object { name: "Valentina", middlename: "Nevaeh", middleInitial: "N.", lastname: "Adams", initials: "V.A", email: "valentina.adams@hotmail.com", academicTitle: "Prof.", sex: "woman", age: 23, height: "4.1", … }
    */
</script>
```

### npm

```bash
npm i --save-dev mockachino
```

### import or require

```js
//for import remember to transpile your code with babel
const mocka = require('Mockachino');

let mocka = new Mockachino({
    locale: 'us',
    person: {
        sex: 'man',
        height: 'tall',
        age: '20s'
    }
});

console.log(mocka.mock().person);
/*
e.g: Object { name: "Elias", middlename: "Ethan", middleInitial: "E.", lastname: "Coleman", initials: "E.C", email: "elias.coleman@hotmail.com", academicTitle: "Dr.", sex: "man", age: 25, height: "5.10", … }
*/
```

## Options

| Option | Description |
| --- | --- |
| Locale | Defines the locale the data should be based on. Defaults to 'us', more locales to come |
| Person | Mock a person, define the person sex, age, and height |

|Person||
|--|--|
|sex| woman, man|
|height| tall, short|
|age| young, old, 20s, 30s|

## Badges

[![Build Status](https://travis-ci.org/akaizn-junior/mockachino.svg?branch=master)](https://travis-ci.org/akaizn-junior/mockachino)

## Shout outs

[lunapic](https://www110.lunapic.com/editor/) and [frankie on Unsplash](https://unsplash.com/photos/F_EfOSXh0sI?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) for the amazing editor and pic that allowed me to make the awesome logo.

[jsdoc](https://github.com/jsdoc3/jsdoc) and [minami](https://github.com/Nijikokun/minami) for being awesome at generating awesome websites from simple comments.

[makever](https://www.npmjs.com/package/makever) for making creating releases on github super easy.

## Author

&copy; 2018 [Simao Nziaka](https://simaonziaka.com)

## Licence

The MIT License [MIT](https://opensource.org/licenses/MIT)

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