Documentation GitHub YouTube

Global

Methods

# module:api() → {e.Router}

Builds the master router

View Source api/api.js, line 43

e.Router

# serverReady(protocol, port) → {void}

Build a message to the console when the API is ready

Parameters:
Name Type Description
protocol "http" | "https"

Protocol used
port Number

Listening port

View Source server.js, line 28

void

# startServer() → {void}

Start the API

View Source server.js, line 53

void

# swaggerReady(protocol, port, swaggerPath) → {void}

Build a message to the console when the Swagger UI docs are ready

Parameters:
Name Type Description
protocol "http" | "https"

Protocol used
port Number

Listening port
swaggerPath string

Path to the Swagger UI docs

View Source server.js, line 42

void