alternatex/store

Lightweight storage wrapper

Store

, _(*1)

A lightweight datastore wrapper providing CRUD operations for arbitrary objects., _(*2)

Index

• Quickstart
  • Embedding
• Client API
  • Store
    • Configure
    • Create
  • Object
    • Create
    • Read
    • Update
    • Delete
  • Summary
• Server API
• Repositories
  • File Stores
    • CSV
    • JSON
    • Serialized
• Documentation
• Roadmap
• License

Quickstart

Embedding

Require.js

require(["store"], function(Store) {
  // ...
});

HTML

<script src="src/client/store.js"></script>

Client API

Store

Configure

Defaults are configured as follows:, _(*3)

Store.configure({ 
  url: "http://localhost/datastore.php", 
  ttl: 3600
});

Note, _(*4)

configure() alters the prototype object, hence modifications are propagated to instances on property level given that the respective instance properties have not been modified previously., _(*5)

Create

var objectStore = new Store({ namespace: 'object' });

Object

Create

Preset

var object = objectStore.create({ 
  country: 'USA', 
  firstname: 'Stephen', 
  lastname: 'Colbert' 
}); 

Barebone

var object = objectStore.create(); 
object.set('country', 'USA');
object.set('firstname', 'Jon'); 
object.set('lastname', 'Stewart'); 

Read

List

objectStore.list();

Single

objectStore.get('8c0c1ff0-d0fe-38b7-376a-b0b1d53bd557');

Update

Instance

object.update();

Datastore

objectStore.update(object);

Delete

Instance

object.remove();

Datastore

objectStore.remove(object);

Summary

Routes

..., _(*6)

Server API

, _(*7)

Repositories

File Stores

Collections stored on a file basis., _(*8)

Limitations, _(*9)

Built with prototyping in mind. Won't scale., _(*10)

CSV

..., _(*11)

JSON

Supports embedding binary data base64 encoded., _(*12)

Serialized

Stores data using PHPs serialize() function. Supports embedding binary data base64 encoded., _(*13)

Documentation

• API
• Examples

Roadmap

• Access Control
• Synchronization
• JSON Schema
  • Generators

License

Released under two licenses: new BSD, and MIT. You may pick the license that best suits your development needs., _(*14)

https://raw.github.com/alternatex/store/master/LICENSE, _(*15)