Simple Fake Model

Simple fake model to avoid using real databases in teaching

Table of Contents

• Introduction
• API
• Installation
• NPM tasks
• Contributing and help
  • Criticism
  • Developing
  • Bug reports, feature requests and discussion
• License
• Frequently Asked Questions

Introduction

This is a simple library which avoids using real database in my JavaScript teachings.

It is just a stupid wrapper around a array which provides a easy API for listing, adding, getting and removing items.

API

const FakeModel = require('simple-fake-model');

const model = new FakeModel();

Implemented features:

• 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.

Installation

Install using NPM

npm install --save simple-fake-model

Useful npm tasks

The module has some npm scripts which could be useful for developing purpose:

• npm test runs the linter, all the tests and gives test coverage statistics
• npm run test:unit runs the unit testing. Using npm run test:unit:watch will watch for changes
• npm run test:coverage show coverage statistics
• npm run lint lints the code

Contributing and help

Criticism

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.

Developing

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.

Bug reports, feature requests and discussion

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.

License

Copyright (c) 2016 Francisco Canela. Licensed under the MIT license.

Frequently Asked Questions

Can I use it in production?

Never. This project has been created for teaching and not for production.