Morepo NPM | npm.io

Mongoose-Repo (morepo)

A Mongoose Repository Class

Requirements

Make sure you're using Nodejs 8.x or higher, for async/await to work

If you're working on Nodejs 6.x, please install morepo version 0.8

Installation

You can install this module with NPM:

npm install --save morepo

Getting started

You can use this class like it is or make a specific Repository class that extends this class

Usecase 1:

const mongoose = require('mongoose');
const Repository = require('morepo');

const postRepo = new Repository(mongoose.model('Post'));

Usecase 2:

const mongoose = require('mongoose');
const Repository = require('morepo');

class PostRepository extends Repository {

    constructor(model) {
        super(model || mongoose.model('Post'));
    }

    // Override an existing function to add some custom functionality
    async findByObjectId(objectId) {
        try {
            if (!objectId) {
                return {error: 'No ObjectId given'};
            }

            const body = await this.find(
                {_id: objectId},
                this.generateOptions({multiple: false})
            );
            if (body === null) {
                return {error: 'No posts found'};
            }
            return body;
        } catch (error) {

            return {error: error.message};
        }
    }

    generateOptions(options) {
        const base = {
            populate: [
                {path: 'author', select: '-password -registration_date -__v'},
                {path: 'comments'}
            ],
            sort: {date_created: 'descending'},
            multiple: true
        };
        return super.generateOptions(base, options);
    }
}

const postRepo = new PostRepository(mongoose.model('Post'));

Functions

Constructor

Creates a new instance of the Repository

Params

model - Mongoose Model
Options:
- applyStatics - default: true Applies all static model functions to the Repo

Returns

New instance of the Repository

create

Params

obj - Object to save to the database

Returns

Given object saved to the database

find

Executes the given query

Params

query - Object
Options:
- select
- populate
  - If something else than an Array, String or Object is given, the value is skipped
  - Examples Populate examples: String: created_by Object (with multilevel populate):
```
```JS
    {
       path: 'friends',
       // Get friends of friends - populate the 'friends' array for every friend
       populate: { path: 'friends' }
    }
```
```
    Array: [One of the 2 above]
- limit
- skip
- sort
- lean - default: false
- count - default: false
- multiple - default: true