blog-it-dao

    0.1.1 • Public • Published

    blog-it-dao

    Build Status

    blog-it-doa is a nodejs module to create services in order to perform standard CRUD operation on a mongodb collection. The whole API returns promises

    Getting started

    You will need a connected db instance. Then simply use the factory like this:

    //assuming you have a connected db in the 'db' variable
    var daoFactory=require('blog-it-dao');
    var service=daoFactory(db,'a collection');
     
    //now you can use your service
    service.findOne('id').then(function(item){
     
    });

    API

    Refer to the mongodb nodejs driver documentation for further details. The main difference is that blog-it-dao API does not take a callback but return a promise which will be resolve with the expected result or rejected with the error if any

    collection.findOne(selector, options, function(err, item){
        if(err){
            console.log(err);
            throw err;
        }
        //do something with the item
    });

    will be

    daoService.findOne(selector, options).then(function(item){
            //do something with the item
        },
        function(err){
            console.log(err);
        }
    );

    The supported method are

    additionally, blog-it-dao expose some method "by id":

    • findById(id, options): equivalent to findOne with selector {_id:id}
    • removeById(id, options): equivalent to remove with selector {_id:id}
    • updateById(id, options): equivalent to update with selector {_id:id}

    running test

    simply run npm test in a command shell

    Licence

    Copyright (C) 2014 Laurent Renard.

    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.

    Install

    npm i blog-it-dao

    DownloadsWeekly Downloads

    4

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • lorenzofox3