Simple Fake Model
Simple fake model to avoid using real databases in teaching
Table of Contents
- NPM tasks
- Contributing and help
- Frequently Asked Questions
It is just a stupid wrapper around a array which provides a easy API for listing, adding, getting and removing items.
const FakeModel = require('simple-fake-model'); const model = new FakeModel();
model.list()which returns an array with all the items stored.
model.insert(object)which accepts an object and stores it with an
id. Inserted item is returned.
model.getById(id)which accepts an id and returns the item stored with provided id.
model.deleteById(id)which removes the item with provided id.
model.updateById(id, object)which updates the item with provided id.
All the methods returns the value using an ES6 Promise.
Install using NPM
npm install --save simple-fake-model
The module has some
npm scripts which could be useful for developing purpose:
npm testruns the linter, all the tests and gives test coverage statistics
npm run test:unitruns the unit testing. Using
npm run test:unit:watchwill watch for changes
npm run test:coverageshow coverage statistics
npm run lintlints the code
I know the library is stupid as hell. It's probably a feature.
If you think something could be done better or simply sucks, bring up a issue on the tracker. Don't be shy. I really love feedback and technical discussions.
Pull requests are welcome (and will make me cry in joy) as long as they pass tests for included and old features.
Did I already say that I love technical discussions? Feel free to open a issue on the tracker if you have any doubt.
Use the GitHub issue tracker to report any bugs or file feature requests. In case you found a bug and have no GitHub account, feel free to email me: fcanela.dev at gmail dot com.
Copyright (c) 2016 Francisco Canela. Licensed under the MIT license.
Can I use it in production?
Never. This project has been created for teaching and not for production.