https://github.com/nicolastakashi/fluent-fakerjs
Build Fake Data using FakerJS with a Fluent API
https://github.com/nicolastakashi/fluent-fakerjs
es6 faker faker-library fakerjs fluentapi javascript nodejs typescript
Last synced: about 1 year ago
JSON representation
Build Fake Data using FakerJS with a Fluent API
- Host: GitHub
- URL: https://github.com/nicolastakashi/fluent-fakerjs
- Owner: nicolastakashi
- License: mit
- Created: 2018-04-13T19:59:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-13T21:15:12.000Z (over 8 years ago)
- Last Synced: 2024-10-12T21:06:17.244Z (almost 2 years ago)
- Topics: es6, faker, faker-library, fakerjs, fluentapi, javascript, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 44.9 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fluent FakerJS
Fluent FakerJS is a module built on top of [FakerJS] to help you write fake date using a fluent api.
## Instaling
```
yarn add fluentfaker --dev
// or
npm install fluentfaker --save-dev
```
## Usage
Build JSON Object.
```
import FluentFaker from 'fluentfaker'
const object = FluentFaker.make()
.rule('name', rule => rule.name.findName())
.rule('email', rule => rule.internet.email())
.rule('jobtitle', rule => rule.name.jobTitle())
.build();
```
Build Form Data
```
import FluentFaker from 'fluentfaker'
const object = FluentFaker.make()
.rule('name', rule => rule.name.findName())
.rule('email', rule => rule.internet.email())
.rule('jobtitle', rule => rule.name.jobTitle())
.buildAsFormData();
```
## Rules available
Visit [FakerJS] page to get more details about all methods that can be used in Fluent Faker rules.
[fakerjs]: https://github.com/Marak/faker.js
## Tests
```
yarn
yarn test
```
## Building Fluent FakerJS
Fluent FakerJS uses typescript and yarn, you just need run `yarn` to install dependencies and you're welcome to fix a bug or add a new feature.
Feel free to open a issue or send a pull request.