yamb v0.0.11

Yamb

Currently you must use the --harmony flag when running node 0.11.x to get access to generators.

You can chat with me. Thanks to gitter.

Installation

$ npm install yamb

Examples

var co = require('co');

var mongo = require('co-easymongo')({
  dbname: 'test'
});

var yamb = require('yamb')({
  storage: mongo.collection('posts')
});

co(function *() {
  var post = yamb.create({
    title: 'Yamb header',
    text: 'Yamb markdown **text**'
  });

  post = yield post.save();

  console.log(post.json());
})();

API

Yamb

Options

• storage (object) — mongodb driver, for example co-easymongo or any related.
• yapi (string) — api key for yandex translate service (optional).

Methods

• create([data]) — returns a new instance of the Yamb class.
• fetch([params][, options]) — find document via params and return Yamb instance.
• fetchAll([params][, options]) — find documents via params and return array of Yamb instance.
• remove([params]) — remove documents.

Yamb class

Methods

• update(params) — update all the properties from params.
• save() — save all data to storage.
• remove() — remove from storage.
• reset() — reset all changes.
• similar([all=false]) — returns an array of similar Yamb's.
• next([all=false]) — returns next Yamb, if not found returns false.
• prev([all=false]) — returns previous Yamb, if not found returns false.
• html(text) — convert markdown text to html.
• json([newer=false]) — returns all properties in json format.

Properties

• uri — string
• title – string
• preview – markdown text
• text – markdown text
• cover – string
• author – object
• tags – array
• related – array
• meta – object
• social – object
• stats – object
• created – date
• publish – date
• active – boolean

For more info about properties look to default schema file.

Author

• Alexey Simonenko

License

The MIT License, see the included license.md file.