Function

Static Public 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.

Static Public

import {createLogger} from 'beerio-api/src/config/logger.js'

Function to create a global logger object based on the properties of the logger function.

Name	Type	Attribute	Description
pretty	Boolean	optional nullable: true	Pretty mode for output with colors.
verbose	Boolean	optional nullable: true	Debug mode for no output.
winston	winston	optional default: _createWinston() nullable: true	The Winston object to create a global logger.

void

import {createTemp} from 'beerio-api/src/utils.js'

Create the temporary directory.

void

import doSetup from 'beerio-api/src/config/setup.js'

Setup the Express service.

Name	Type	Attribute	Description
app	Express		The ExpresssJS instance.
pretty	Boolean	optional nullable: true	Pretty output with Winston logging.
verbose	Boolean	optional nullable: true	Debug mode for no output.

void

import {executeCommand} from 'beerio-api/src/utils.js'

Execute a command from within the root folder.

Name	Type	Attribute	Description
cmd	String		The command to execute.

The output of the command.

import {resetLog} from 'beerio-api/src/utils.js'

Reset the default log file.

void

import setupRoutes from 'beerio-api/src/config/routes.js'

Setup ExpressJS routing.

Name	Type	Attribute	Description
app	ExpressJS		The ExpresssJS application.

void