Class: Server

new Server()

Server class

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 54
See: https://www.npmjs.com/package/express

Example

const {Runtime, Server} = require('@neobeach/core');
const Api = require('./routers/Api');

const server = new Server();

Runtime(() => {
    server.includeDefaultBodyParsers();
    server.loadRouters([Api]);
    server.run();
});

Methods

includeDefaultBodyParsers()

Includes/loads default express body parsers (json, text, urlencoded and multer) with recommended config into the Express app

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 365
See: https://expressjs.com/en/api.html#express.json
https://expressjs.com/en/api.html#express.text
https://expressjs.com/en/api.html#express.urlencoded
https://github.com/expressjs/multer

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.includeDefaultBodyParsers();
    server.run();
});

includeDefaultCompression()

Includes/loads default compression (deflate, gzip) with recommended config into the Express app

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 456
See: https://www.npmjs.com/package/compression

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.includeDefaultCompression();
    server.run();
});

includeDefaultCookieParser()

Includes/loads cookie parser with recommended config into the Express app

Since: 2.1.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 487
See: https://github.com/expressjs/cookie-parser

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.includeDefaultCookieParser();
    server.run();
});

includeDefaultCorsHeaders(origin)

Includes/loads default CORS headers with recommended config into the Express app

Parameters:

Name	Type	Description
`origin`	String	String with allowed origin URL's

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 426
See: https://www.npmjs.com/package/cors

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.includeDefaultCorsHeaders();
    server.run();
});

includeDefaultSecurityHeaders()

Includes/loads default security headers with recommended config into the Express app

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 396
See: https://www.npmjs.com/package/helmet

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.includeDefaultSecurityHeaders();
    server.run();
});

loadMiddlewares(middlewares)

Load global middlewares into the Express app

Parameters:

Name	Type	Description
`middlewares`	array.<function(, , *)>	An array with Express middleware functions

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 183
See: http://expressjs.com/en/guide/writing-middleware.html

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
   server.loadMiddlewares([
       (req, res, next) => {
           // Execute custom code here
           next();
       }
   ]);
   server.run();
});

loadRemixFramework(serverBuild)

Attach a Remix Framework build to our Express server

Parameters:

Name	Type	Description
`serverBuild`	*	A Remix Server build

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 520
See: https://remix.run/docs/en/v1
https://remix.run/docs/en/v1/other-api/adapter

Example

import * as serverBuild from "@remix-run/dev/server-build";

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.loadRemixFramework(serverBuild);
    server.run();
});

loadRouters(routers)

Load routers into the Express app

Parameters:

Name	Type	Description
`routers`	array	An array with Routers

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 212

Example

const {Runtime, Server} = require('@neobeach/core');
const Api = require('./routers/Api');

const server = new Server();

Runtime(() => {
    server.loadRouters([Api]);
    server.run();
});

loadStatic(directory, prefixopt)

Serves a static directory from the Express app

Parameters:

Name	Type	Attributes	Default	Description
`directory`	string			Local directory path where the static files live
`prefix`	string	<optional>	/	Optional prefix to create a virtual path

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 273
See: https://expressjs.com/en/starter/static-files.html

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.loadStatic('public');
    server.run();
});

run() → {function}

Starts the Express server

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 150

Returns:

Type:: function

Example

const {Runtime, Server} = require('@neobeach/core');
const Api = require('./routers/Api');

const server = new Server();

Runtime(() => {
    server.run();
});

setEJSViewEngine(views)

Sets the Express render engine to EJS

Parameters:

Name	Type	Description
`views`	string	Path to the EJS views directory

Since: 2.1.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 335
See: https://expressjs.com/en/guide/using-template-engines.html
https://ejs.co/

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.setEJSViewEngine(`${__dirname}/views`);
    server.run();
});

setParameter(name, value)

Sets an Express app parameter

Parameters:

Name	Type	Description
`name`	string	An express parameter name
`value`	*	You specified value for the parameter

Since: 1.0.0
Author: Glenn de Haan
Copyright: MIT
Source: Server.js, line 306
See: https://expressjs.com/en/4x/api.html#app.set

Example

const {Runtime, Server} = require('@neobeach/core');

const server = new Server();

Runtime(() => {
    server.setParameter('title', 'My Site');
    server.run();
});