npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

bap-node-microframework-mongoose

v1.0.2

Published

Wrapper mongoose plugin for bap-node-microframework.

Downloads

3

Readme

node-microframework-mongoose

Wrapper mongoose plugin for bap-node-microframework.

Installing

To install and add the dependecy to the package.json, run the following command:

npm install bap-node-microframework-mongoose --save

Configuration

To create a connection to mongodb://localhost:27017, write the following code in app/app.ts:

// app/app.ts
...

import { MongoosePlugin } from 'bap-node-microframework-mongoose';

...

import { Kernel } from "./kernel";
var kernel = new Kernel();
var App = new Application(<ApplicationOptions>{
    ...
}, <KernelInterface>kernel);

...

App.registerPlugin(MongoosePlugin, { "dsn": "mongodb://localhost:27017" });

...

App.start();

...

Using

Model

To create a User Mongoose model, write the following code in app/modules/user/models/user.ts:

// app/modules/user/models/user.ts
import { Container } from 'bap-node-microframework/core';

export class UserModel {
    static define(mongoose) {
        let userSchema = {
            username: String,
            email: String,
            password: String,
            firstname: String,
            lastname: String
        };
        userSchema = Container.get('mongoose').Schema(userSchema);
        return Container.get('mongoose').model('User', userSchema);
    }
}

BaseController

If you want to use the BaseController abstract class:

import { BaseControllerMongoose } from 'bap-node-microframework-mongoose';

...

class MyClass extends BaseControllerMongoose {
    ...
}

ParamConverter

You can use the paramConverter decorator to get some data from the database before executing a function in a controller.

The paramConverter signature is:

ParamConverterMongoose(aName, { 'model': modelName, 'filterBy': { fieldDB: fieldParam } })

where:

  • aName (String): name to use when you have to access the data in the controller function (with req.params.aName, e.g. req.params.user). Example: "user"
  • modelName (String): model name to use for the request. Example: "User" (create in the Model section).
  • fieldDB (String): Field name in the MongoDB instance. Example: "_id".
  • fieldParam (String): Field parameter to use in the router (e.g. @Get('/users/:id')). Example: "id".

If you want to use the ParamConverter:

import { BaseControllerMongoose, ParamConverterMongoose } from 'bap-node-microframework-mongoose';

...

class UserController extends BaseControllerMongoose {
    @ParamConverterMongoose('user', { 'model': 'User', 'filterBy': { '_id': 'id' } })
    ...
}

...

Example of a controller

The following code presents a complete example of a controller:

// app/modules/user/controllers/user.ts
import { Put, WithRouter } from 'bap-node-microframework/decorators';
import { ParamConverterMongoose, BaseControllerMongoose } from 'bap-node-microframework-mongoose';
import userForm from '../../user/forms/user';

@WithRouter()
class UserController extends BaseControllerMongoose {

    @ParamConverterMongoose('user', { 'model': 'User', 'filterBy': { '_id': 'id' } })
    @Put('/users/:id', { authenticated: false })
    update(req, res) {
        super.put(req.params.user, userForm(req), req, res);
    }
}

export default UserController.router;