Home Reference Source Repository

References

Class Summary

Static Public Class Summary
public	BeerController Class for CRUD operations for beers.
public	Index Class for starting the API.
public	IndexController Class for displaying information about the server the API is running on.
public	UserController Class for CRUD operations for users.

Function Summary

Static Public Function Summary
public	createLogger(pretty: Boolean, verbose: Boolean, winston: winston): void Function to create a global logger object based on the properties of the logger function.
public	createTemp(): void Create the temporary directory.
public	doSetup(app: Express, pretty: Boolean, verbose: Boolean): void Setup the Express service.
public	executeCommand(cmd: String): Promise Execute a command from within the root folder.
public	resetLog(): void Reset the default log file.
public	setupRoutes(app: ExpressJS): void Setup ExpressJS routing.

Variable Summary

Static Public Variable Summary
public	Promise: Promise The promise object to override the mongoose promise object.
public	dbHosts: Array The host of the server of the database.
public	dbName: String The name of the database.
public	master: Boolean Check if this instance of the API is the master.
public	pageSize: Integer The amount of object show per page.
public	port: Integer The port on which the API will run on.
public	server: String The name of the server.
public	tempDir: String The path to the temprary directory.
public	workers: Integer The amount of workers on the cluster.

External Summary

Static Public External Summary
public	ExpressWinston: ExpressWinston Create an Express Winston instance.
public	Winston: Wintson Create a Winston instance.