methodulus

Methodulus

motivation

• we want microservices!
• we need a dynamic system architecture!
• we want it all!

automatic server to server connectivity using a dynamic rpc transport layer

npm i -S methodulus

Hello methodulus

This example creats a rest (express based) server using a controller class Player

it is configured to run the class code locally via an http server.

import { Player } from './player';
import { Server, MethodType, MethodulusConfig } from 'methodulus';


MethodulusConfig.config['Player'] = MethodType.Local;
MethodulusConfig.servers = ['rest'];
const server = new Server(process.env.PORT || 8020);
server.useClass(Player);

the Player class

import { Body, Method, MethodConfig, MethodType, Param, Query, Verbs, MethodError, MethodResult } from 'methodulus';
import { PlayerModel } from '../models/player';


@MethodConfig('Player')
export class Player {
    @Method(Verbs.Post, '/api/player')
    public async create() {
        let p = new PlayerModel('1', 'player 1');
        await DB.Player.insert(p);
        return new MethodResult(p)
    }

    @Method(Verbs.Get, '/api/player/:player_id')
    public async read( @Param('player_id') playerId: number) {
        return await DB.Player.find({ 'Id': playerId });
    }

    @Method(Verbs.Put, '/api/player')
    public async update() {

    }


    @Method(Verbs.Delete, '/api/player')
    public delete() {

    }



}

Classes & API

MethodulusConfig

configuration must complete before the server starts. configure each controller class to its desired state

MethodulusConfig.config['Player'] = MethodType.Local;

here we configure the class Player to run locally.

MethodType

avaliable options are Local | Http | MQ | Socket

Local

run the code in the class, no proxy or transport required.

Http

run the code using an http request to a microservice.

MQ

use amqp rpc to execute the class code

Socket

directly connect to a server using websocket connection.

Server

creates an agnostic configured server.

const server = new Server(process.env.PORT);