import HttpServer from 'pop-api/src/middleware/HttpServer.js'

public class | source

HttpServer

Class for starting the API.

Constructor Summary

Public Constructor
public	constructor(PopApi: PopApi, options: Object) Create a new Server object.

Public Members
public	server: http~Server the http server object.
public	serverPort: number The port on which the API will run on.
public	workers: number The amount of workers on the cluster.

Public Methods
public	closeApi(database: Database, done: Function): undefined Method to stop the API from running.
public	forkWorkers(): undefined For the workers.
public	setupApi(app: Express): undefined Method to setup the cron job.
public	workersOnExit(): undefined Handle the errors for workers.

Create a new Server object.

Name	Type	Attribute	Description
PopApi	PopApi	nullable: false	The PopApi instance to bind the server to.
options	Object	nullable: false	The options for the server.
options.app	Express	nullable: false	The application instance to create a server for.
options.serverPort	number	optional default: process.env.PORT nullable: false	The port the API will run on.
options.workers	number	optional default: 2 nullable: false	The amount of workers to fork.

'app' is a required option for the HttpServer middleware!

the http server object.

The port on which the API will run on. Default is 5000.

The amount of workers on the cluster.

Method to stop the API from running.

Name	Type	Attribute	Description
database	Database	nullable: false	The database connection to close.
done	Function	optional nullable: true	Function to exit the API.