@lykmapipo/mongoose-faker

mongoose plugin to generate fake model data

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1112Jun 18, 2021Apr 11, 2018Minified + gzip package size for @lykmapipo/mongoose-faker in KB

Readme

mongoose-faker

Build Status Dependencies Status npm version

mongoose plugin to generate fake model data

Requirements

  • NodeJS v6.5+

Install

$ npm install --save @lykmapipo/mongoose-faker

Usage

const mongoose = require('mongoose');
mongoose.plugin(require('mongoose-faker'));
const Schema = mongoose.Schema;

const UserSchema = new Schema({
  name: {
    type: String,
    fake: {
      generator: 'name',
      type: 'firstName'
    }
  }

});
const User = mongoose.model('User', UserSchema);

...

const user = User.fake();
const users = User.fake(50);

...

API

Static

Model.fake(size, locale): model|model[]

Return fake model(s) instance base of specified size and locale

Example:

const user = User.fake();
const users = User.fake(4);

Model.fakeOnly(...fields): model|model[]

Return a fake model(s) instance with only specified fields

Example:

const user = User.fakeOnly('name', 'age');
const users = User.fakeOnly(4, 'name');

Model.fakeExcept(...fields): model|model[]

Return fake model(s) instance without specified fields

Example:

const user = User.fakeExpect('name', 'age');
const users = User.fakeExpect(4, 'name', 'age');

Instance

model.fakeOnly(...fields): model

Return updated fake model instance with only specified fields updated

Example:


....

const user = user.fakeOnly('name');
const user = user.fakeOnly('name', 'age');

model.fakeExcept(...fields): model

Return updated fake model instance with specified fields not updated

Example:


...

const user = user.fakeExpect('name', 'age');
const users = user.fakeExpect('name', 'age');

Testing

  • Clone this repository

  • Install all development dependencies

    $ npm install
    
  • Then run test

    $ npm test
    

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

Licence

The MIT License (MIT)

Copyright (c) 2015 lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.