le-storage-service

A simple ORM for real-time datastores

This service and the objects it creates rely heavily on promises for asynchronous tasks. A storage provider (such as le-storage-provider-firebase) is required when constructing the storage object.

Installation

npm install le-storage-service --save

Usage

  var StorageProvider = require('le-storage-provider-firebase');
  var provider = new StorageProvider(/* your firebase url */);
  var StorageService = require('le-storage-service');
  var storage = new StorageService(provider);

  var castle = storage.createRecord('Company');
  castle.update({name: 'Castle', industry: 'Real Estate', founded: 2014})
  .then(function () {
    ...
  });

Tests

• npm test to run unit tests once
• gulp tdd to run unit tests on every file change
• gulp coverage to run unit tests and create a code coverage report

Contributing

Please follow the project's conventions or your changes will not be accepted

Release History

• 2.0.3 Prefer reject to throw for functions that return promises
• 2.0.2 Remove data from CollectionService's load in docs
• 2.0.1 Allow sync and load of empty collections
• 2.0.1 Allow sync and load of empty collections
• 2.0.0 Purge has from the api
  • Rename hasOne to relateToOne
  • Rename hasMany to relateToMany
  • Rename hasType to setType and addType for one and many, respectively
• 1.0.0 Add RecordService and CollectionService
• 0.1.3 Configure Travis CI to publish docs to GitHub Pages
• 0.1.2 Add Dependency Status Badge
• 0.1.1 Add Travis CI
• 0.1.0 Initial release