An elegant and stylish version of datastore.

sleek is an observable and polymorphic interface to :

• get
• set, update or reset
• format
• compute
• or extend your data with plugins.

with component:

$ component install bredele/sleek

with nodejs:

$ npm install sleek

var sleek = require('sleek');
var user = sleek();
user('github', 'component');
user('path', function() {
 return 'https://github.com/' + this.github;
});
user('path');
// https://github.com/component
user('github', 'bredele');
user('path');
// https://github.com/bredele

Here's a live example:

and the entire API

Create a new sleek store with optional data.

var sleek = require('sleek');
var user = sleek({
	name: 'bredele'
});

the data can be an object as well as an array, see collection for more details

Set an attribute name.

user('name','olivier');

alias user.set (see datastore)

Get an attribute name.

user('name');

alias user.get (see datastore)

Set multiple attributes.

user({
  github: 'bredele',
  city: 'calgary'	
});
// name is still there

alias user.set (see datastore)

Reset store with data (Object or Array).

user({
  github: 'bredele',
  city: 'calgary'	
}, true);
// name has been erased

alias user.reset (see datastore)

Format existing property.

user('name', function(str) {
	return str.toUpperCase();
});

alias user.format (see datastore)

Compute new property with existing properties.

user('nickname', function() {
	return this.name + ' bang!';
});

A computed property is automatically updated.

alias user.compute (see datastore)

Mixin store with plugins

user(function(store, str) {
	store.hello = function() {};
}, 'hello');

alias user.use (see datastore)

Delete a store attribute.

user.del('nickname');

Listen or emit events on a sleek store.

user.on('change name', function(val, previous) {
  ...
});
user('name', 'olivier');

Here's a list of availaible plugins:

• mirror

to get real time updates from a store in server side.

  user(mirror('mychannel'));
  user('hello', 'world');

• path

to access nested data easily:

  user.path('country.canada'); //get
  user.path('country.canada.city', 'calgary');//set

• supplant

to create template engines on both client/server sides:

  user.filter('upper', function(str) {
    return str.toUpperCase();
  });
  user.supplant('my name is {{name} | upper}');

• queue

to queue events.

  user.queue('hello', 'world');
  user.on('hello', function(val) {
    //world
  });

sleek is a uniq interface for your models and collections. Here's a simple example:

var users = sleek([{
  name: 'olivier'
}, {
  name: 'bob'
}]);
users(0);
// => { name : 'olivier'}
users(1, {
  name: 'bruno'
});
users(1);
// => { name : 'bruno'}

The MIT License (MIT)

Copyright (c) 2014 Olivier Wietrich olivier.wietrich@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.