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

engined-http

v0.0.11

Published

http agent service for engined

Downloads

360

Readme

engined-http

HTTP agent service for engined, which is based on koa 2.

NPM

Installation

Install via NPM:

npm install engined-http

Usage

Start HTTP agent service in engined, see example below:

const { Manager } = require('engined');
const HTTPService = require('engined-http');

const MyHTTPService = HTTPService({
	port: 8080, // optional: default to 3001 if not set
	agentName: 'MyHTTP' // optional: default to 'default' if not set
});

const main = async () => {

	// Create manager
	let serviceManager = new Manager({ verbose: true });

	// Adding agent to manager
	serviceManager.add('MyHTTPService', MyHTTPService);

	// Start all services
	await serviceManager.startAll();
};

main();

Setup Router

For HTTP routing, there is a way to inherit RouterService class to create a router service to manage routes by using koa-router.

const Router = require('koa-router');
const { RouterService } = require('engined-http');

// Create service prototype and specify agent
const Service = RouterService({
	agentName: 'MyHTTP' // optional: default to 'default' if not set
});

class MyRouterService extends Service {

	async setupRoutes() {
		let router = Router();

		router.get('/', async (ctx) => {
			ctx.body = 'Hello!';
		});

		return router;
	}
}

Note: remember to add this service to engined service manager and start it.

Setup Middlewares

By default, HTTP service will apply koa-logger, koa2-cors and koa-bodyparser middlewares. If you would like to apply any perfered middlewares, just override setupMiddleware method of service.

class MyHTTPService extends HTTPService{{ port: 8080 }} {

	async setupMiddleware() {
		// Apply original `koa-logger`, `koa2-cors` and `koa-bodyparser` if you still need it
		await this._setupMiddleware();

		// Add your middleware
		this.agent.use(async (ctx) => {
			// Do something
		});
	}
}

Setup CORS (Cross-Origin Resource Sharing)

By override setupCORS method of service, to make settings as parameter for koa2-cors to support CORS.

class MyHTTPService extends HTTPService{{ port: 8080 }} {

	async setupCORS() {
		return { origin: '*' };
	}
}

Setup Body Parser

The body parser is common middleware to parse HTTP body, we can have settings supported by koa-bodyparser.

class MyHTTPService extends HTTPService{{ port: 8080 }} {

	async setupBodyParser() {
		return {
			jsonLimit: '50mb',
			textLimit: '50mb'
		};
	}
}

Setup Views Renderer

By override setupViews method of service, to enable and setup prefered view renderer.

The returned object for settings:

  • path: Where your views are located. Must be an absolute path. All rendered views are relative to this path
  • templateEngine: The loaded module of template engine
  • options: options object as parameter to koa-views
class MyHTTPService extends HTTPService{{ port: 8080 }} {

	async setupViews() {

		return {
			path: path.join(__dirname, '..', 'views'),
			templateEngine: require('pug'),
			options: {
				extension: 'pug',
				map: {
					html: 'pug'
				}
			}
		};
	}
}

License

Licensed under the MIT License

Authors

Copyright(c) 2017 Fred Chien(錢逢祥) <[email protected]>