https://github.com/flpvsk/co-db

FS-based database to use with co (https://github.com/visionmedia/co).
https://github.com/flpvsk/co-db

Last synced: about 1 month ago
JSON representation

FS-based database to use with co (https://github.com/visionmedia/co).

• Host: GitHub
• URL: https://github.com/flpvsk/co-db
• Owner: flpvsk
• Created: 2014-09-05T15:55:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-18T09:24:53.000Z (over 10 years ago)
• Last Synced: 2024-04-14T20:21:10.794Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 227 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# co-db

[![Build

Status](https://travis-ci.org/filipovskii/co-db.svg?branch=master)](https://travis-ci.org/filipovskii/co-db)

FS-based database to use with [co](https://github.com/visionmedia/co).

## Installation

```

npm install co-db

```

## Examples

### Simple DB

```

$ cd examples/simple-db

$ tree .

.

└── doc1

```

```js

var co = require('co'),

    codb = require('..');

co(function * () {

  var db = yield codb('examples/simple-db');

  var doc = yield db.doc('doc1');

  var contents = yield doc.contents;

  console.log('----Doc Obj----')

  console.log(doc);

  console.log('----Doc Contents----')

  console.log(contents.toString());

  console.log('--------------------')

})();

```

```

$ node --harmony-generators examples/simple-db.js

----Doc Obj----

{ cwd: '/path/to/co-db',

  id: 'doc1',

  base: '/path/to/co-db/examples/simple-db',

  path: '/path/to/co-db/examples/simple-db/doc1',

  contents: [Function] }

----Doc Contents----

   |

   |

   + \

   \\.G_.*=.

    `(H'/.\|

     .>' (_--.

  _=/d   ,^\

 ~~ \)-'   '

    / |

   '  '   a:f

--------------------

```

### JSON DB (middleware example)

```

$ cd examples/json-db

$ tree .

.

├── doc1.json

└── doc2.json

```

```js

// examples/json-db.js

var co = require('co'),

    codb = require('..');

co(function *() {

  var jsonDb = yield codb('examples/json-db'),

      docs = [];

  jsonDb.use(function *(doc){

    var contents = new Buffer(0),

        chunk;

    while (chunk = yield doc.contents) {

      contents = Buffer.concat([contents, chunk]);

    }

    doc.contents = JSON.parse(contents.toString());

  });

  docs = yield jsonDb.docs();

  docs.forEach(function (doc) {

    console.log('id ==', doc.id);

    console.log('contents ==', doc.contents);

    console.log('------------------------------');

  });

})();

```

```

$ node --harmony-generators examples/json-db.js

id == doc1.json

contents == { um: 'oh' }

------------------------------

id == doc2.json

contents == { wow: true }

------------------------------

```

## License

MIT