blueskyfish-express-context v0.3.6

BlueSkyFish Express Context

A small library for express micro services summarize the request and response.

Helpful classes and functions for create a express micro service.

Breaking Change switch to yarn.

Requirements

• NodeJS Version 8.x or higher.
• Yarn
• Typescript Version 2.6.2 or higher.
• Express Version 4.16 or higher

Global installed typescript. npm install --global typescript.

The library is written in Typescript. During the installation of the library it will be compiled into Javascript ES2015 modules.

Installation

$ npm install -S blueskyfish-express-context

Dependencies

All libraries from blueskyfish-express-* and depended applications should use the same version of the dependencies node modules.

Usage

// File: action.get-about.ts
import { ActionFunc, IContext } from 'blueskyfish-express-context';

export const name: string = '[about] get about';
export const action: ActionFunc<IContext> = (ctx: IContext) => {
	ctx.sendData({
		version: '1.0.0',
		name: 'Demo',
		title: 'Demo Application'
	});
};

// File: about.module.ts
import * as fromGetAbout from './action.get-about.ts';

export const AboutNames = {
	GET_ABOUT: fromGetAbout.name,
};

export class AboutModule {
	
	static forApp(): IActionPool {
		return new BaseActionPool()
			.addAction(fromGetAbout.name, fromGetAbout.action);
	}
}

// File: app.ts
import * as express from 'express';
import { Log } from 'blueskyfish-express-commons';
import { AboutNames, AboutModule } from './about.module';

const APP_TAG: string = 'demo';
const app: express.Application = express();
const actions: ActionRepository = new ActionRepository()
	.addPool(AboutModule.forApp());

app.get('/about', toRouteHandler(actions, AboutNames.GET_ABOUT));

const server: Http = app.listen(3003, 'localhost', () => {
	Log.info(APP_TAG, 'Demo server is listen @ http://localhost:3003');
});

Env.addShutdown((signal: string) => {
	Log.info(APP_TAG, 'Signal "%s" is receive for shutdown...', signal);
	server.close(() => {
		Log.info(APP_TAG, 'Demo server is stopped');
		Env.exit(0);
	});
});

History

License

The MIT License
Copyright 2018 BlueSkyFish