Class: Module

Methods

(inner) disableLogging()

Disables logging

Source:

• module.js, line 672

(inner) enableLogging()

Enables logging (enabled by default)

Source:

• module.js, line 679

(inner) exit(code)

Kills the node process

Parameters:

Name	Type	Description
code	int	What code to exit the process with

Source:

• module.js, line 748

(inner) getConfig() → {module}

Gets the config of the Module

Source:

• module.js, line 430

Returns:

The config for Module

Type

module

(inner) getExpress() → {object}

Gets the SnoozeJS Express

Source:

• module.js, line 452

Returns:

ExpressJS App

Type

object

(inner) getInjectable(parameter, obj)

Gets an injectable. When getting injectables, MockEntityManager will be checked first. With the exception to DAOs.

Parameters:

Name	Type	Description
parameter	string	The name of the injectable to get
obj	object	Optionally an object that is requesting the injectable. This will be added to the objects recorded injectables list.

Source:

• module.js, line 354

(inner) getName() → {string}

Gets the name of the Module

Source:

• module.js, line 422

Returns:

The name of the Module

Type

string

(inner) getParams(func) → {array}

Gets the parameter from a function

Parameters:

Name	Type	Description
func	function	A function

Source:

• module.js, line 702

Returns:

Array of parameters

Type

array

(inner) getRouteManager() → {object}

Gets the SnoozeJS RouteManager

Source:

• module.js, line 468

Returns:

RouteManager

Type

object

(inner) getRoutes() → {array}

Gets the SnoozeJS routes from the routeManager

Source:

• module.js, line 460

Returns:

Array of routes

Type

array

(inner) getSnooze() → {object}

Gets the SnoozeJS NPM Module

Source:

• module.js, line 484

Returns:

SnoozeJS NPM Module

Type

object

(inner) init()

Creates the $module service

Source:

• module.js, line 169

(inner) initEnv()

Sets process env vars from the snooze.json env config

Source:

• module.js, line 182

(inner) initMiddleWare()

Sets express middlewares to use

Source:

• module.js, line 258

(inner) initOrigin()

Sets allow origin headers if allowOrigin is set in the snooze.json config

Source:

• module.js, line 242

(inner) initPort()

Sets the port to 8000 if port has not already been defined and isn't defined in the config.

Source:

• module.js, line 286

(inner) initSSL()

Loads key/cert files from paths defined in snooze.json

Source:

• module.js, line 195

(inner) inTestMode() → {boolean}

Returns true of in testing mode

Source:

• module.js, line 438

Returns:

True if in testing mode

Type

boolean

(inner) isAwake() → {boolean}

Returns true of wakeup() has been called

Source:

• module.js, line 476

Returns:

Type

boolean

(inner) libs(loadLibs) → {object}

Sets the lib directories to load

Parameters:

Name	Type	Description
loadLibs	array	Array of directories

Source:

• module.js, line 524

Returns:

Module

Type

object

(inner) log(msg)

Logs a message. Logs will not be printed when logging is disabled.

Parameters:

Name	Type	Description
msg	string	The message to log

Source:

• module.js, line 719

(inner) mergeModeConfig()

Merges modeConfig (like production or dev) into the runtime config

Source:

• module.js, line 276

(inner) mergeStartingConfig()

Merges startingConfig (if defined in wakeup()) into the runtime config

Source:

• module.js, line 267

(inner) port()

Alias to setPort

Source:

• module.js, line 558

(inner) requireLibs(bp)

Requires files found in lib paths

Parameters:

Name	Type	Description
bp	string	Set the base path to search from (defaults to cwd)

Source:

• module.js, line 210

(inner) route(method, path, options) → {object}

Records a route in the Module. These will be compiled by the RouteManager when wakeup() is called.

Parameters:

Name	Type	Description
method	string	HTTP Method (GET, POST, PUT, DELETE)
path	string	HTTP Path (ex: /users)
options	object	Route options

Source:

• module.js, line 541

Returns:

Module

Type

object

(inner) run(fn) → {object}

Creates a run function to run after wakeup() has been called.

Parameters:

Name	Type	Description
fn	function	An injection function to run.

Source:

• module.js, line 758

Returns:

Module - The SnoozeJS Module

Type

object

(inner) setPort(port) → {object}

Sets the server port

Parameters:

Name	Type	Description
port	int	The port to use

Source:

• module.js, line 568

Returns:

Module

Type

object

(inner) setPostLimit(postLimit) → {object}

Sets the post limit of http requests

Parameters:

Name	Type	Description
postLimit	string	Post limit string (default: '50mb')

Source:

• module.js, line 590

Returns:

Module

Type

object

(inner) ssl(ssl) → {object}

Sets the ssl config

Parameters:

Name	Type	Description
ssl	object	SSL Config

Source:

• module.js, line 579

Returns:

Module

Type

object

(inner) startExpress()

Starts the express server with the express options.

Source:

• module.js, line 299

(inner) wakeup(startingConfig)

Starts the SnoozeJS server

Parameters:

Name	Type	Description
startingConfig	object	Additional config (see snooze.json) that will merge into the snooze.json at runtime

Source:

• module.js, line 314

(inner) warn(msg)

Logs a warning. Logs will not be printed when logging is disabled.

Parameters:

Name	Type	Description
msg	string	The warning to log

Source:

• module.js, line 733