model-golem
v1.0.3
Published
A model factory JS library to generate data mocks
Downloads
2
Readme
model-golem
A model factory JS library to generate data mocks
Installing
npm install --save-dev model-golem
Using
Load the Factory:
// NodeJS / CommonJS Modules
var Factory = require('model-golem');
// ES2015 Modules
import Factory from 'model-golem';
Define a model:
var Person = {
id: function() {
// this.sequence is autoincremented on every creation step, starts from 0
return this.sequence;
},
// Define the attributes giving their default values
name: '',
charisma: 42,
// Reuse attributes
username: function() {
return this.item.name.toLowerCase().replace(/ /g, '');
}
};
Instantiate the Factory with your model:
var peopleFactory = new Factory(Person);
Create your mocks!
var person = peopleFactory({
name: 'Leo Balter',
});
/*
person === {
id: 0,
name: 'Leo Balter',
charisma: 42,
username: 'leobalter'
}
*/
Create your mocks from arrays!
var people = peopleFactory([
{
name: 'Green Avocados',
// replace default values!
charisma: 0
},
{
name: 'Spicy Mustard',
id: 100,
charisma: 37,
username: 'mryellow'
}
]);
/*
people === [
{
id: 2,
name: 'Green Avocados',
charisma: 0,
username: 'greenavocados'
},
{
id: 100,
name: 'Spicy Mustard',
charisma: 37,
username: 'mryellow'
}
]
*/
Get the stored data!
var stored = peopleFactory.store;
/*
stored === [
{
id: 1,
name: 'Leo Balter',
charisma: 42,
username: 'leobalter'
},
{
id: 2,
name: 'Green Avocados',
charisma: 0,
username: 'greenavocados'
},
{
id: 100,
name: 'Spicy Mustard',
charisma: 37,
username: 'mryellow'
}
]
*/